Skip to content

Commit

Permalink
Merge pull request #206 from zonkyio/documentation-polish
Browse files Browse the repository at this point in the history
Polish documentation
  • Loading branch information
bobisjan authored Aug 4, 2019
2 parents 1a1ec9e + 0adb460 commit dc41d60
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 39 deletions.
10 changes: 6 additions & 4 deletions tests/dummy/app/templates/docs/advanced/generating-icons.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Generating Icons

`ember-web-app` doesn't generate icons. If you want to automate the generation of icons starting from a master image, you can install [ember-cli-image-transformer](https://github.com/jrjohnson/ember-cli-image-transformer).
Web App doesn't generate icons. If you want to automate the generation of icons starting from a master image, you can install [ember-cli-image-transformer](https://github.com/jrjohnson/ember-cli-image-transformer).

If your `config/manifest.js` looks like this and needs a `192px` and a `512px` icon:
If your `config/manifest.js` looks like this and needs a `192px` and a `512px` icons:

```javascript
'use strict';
export default function() {

module.exports = function() {
return {
icons: [
{
Expand All @@ -20,13 +21,14 @@ export default function() {
})),
],
};
}
};
```

You can start with a base `brand-icon.svg` image and automatically build the `192x192` and `512x512` versions by installing `ember-cli-image-transformer` and adding the necessary configuration to your `ember-cli-build.js` file:

```javascript
'use strict';

module.exports = function(defaults) {
let options = {
'ember-cli-image-transformer': {
Expand Down
2 changes: 1 addition & 1 deletion tests/dummy/app/templates/docs/advanced/using-cors.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ You can specify `crossorigin` behaviour for `manifest.webmanifest` by updating t
```html
<link
rel="manifest"
href="{{rootURL}}/manifest.webmanifest"
href="{{rootURL}}manifest.webmanifest"
crossorigin="use-credentials"
/>
```
Expand Down
4 changes: 3 additions & 1 deletion tests/dummy/app/templates/docs/getting-started/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ It also generates some compatibility `meta` tags for supporting non-standard ven

## Targets

Internally, Web App takes into account four different types of targets for generating the _Web App Manifest_ taking care of including some backward compatibility `meta` tags in order to support as many devices and browsers as possible. These targets are:
Internally, Web App takes into account several different types of targets for generating the _Web App Manifest_ taking care of including some backward compatibility `meta` tags in order to support as many devices and browsers as possible. These targets are:

- `manifest` (default target)
- `android` (to target Android devices)
- `apple` (to target Apple devices)
- `ms` (to target Win8/Win10 devices)
- `favicon` (to target browser favicons)
- `safari-pinned-tab` (to target Safari Pinned Tab)

_Not all targets are used for all properties (actually, most properties are not affected by the targets)._
62 changes: 29 additions & 33 deletions tests/dummy/app/templates/docs/manifest/available-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,9 @@ manifest.description = 'Lorem ipsum dolor';
Possible values:

- ltr (left-to-right)
- rtl (right-to-left)
- auto
- `ltr` (left-to-right)
- `rtl` (right-to-left)
- `auto`

```javascript
manifest.dir = 'ltr';
Expand All @@ -91,10 +91,10 @@ manifest.dir = 'ltr';
Possible values:

- fullscreen
- standalone
- minimal-ui
- browser
- `fullscreen`
- `standalone`
- `minimal-ui`
- `browser`

The default value for `display` is `browser` when is not defined.

Expand Down Expand Up @@ -133,7 +133,7 @@ icons: [
{
src: '/bar/baz.png',
sizes: '280x280',
targets: ['apple'], // non-standard property
targets: ['apple'], // *
},
{
src: '/bar/fav.png',
Expand All @@ -142,13 +142,13 @@ icons: [
},
{
src: '/bar/ms.png',
element: 'square70x70logo', // non-standard property
targets: ['ms'], // non-standard-property
element: 'square70x70logo', // *
targets: ['ms'], // *
},
{
src: '/foo/monochrome.svg',
safariPinnedTabColor: '#cc6600', // non-standard property
targets: ['safari-pinned-tab'], // non-standard-property
safariPinnedTabColor: '#cc6600', // *
targets: ['safari-pinned-tab'], // *
},
];
```
Expand Down Expand Up @@ -183,14 +183,14 @@ manifest.lang = 'es-UY';
Possible values:

- any
- natural
- landscape
- landscape-primary
- landscape-secondary
- portrait
- portrait-primary
- portrait-secondary
- `any`
- `natural`
- `landscape`
- `landscape-primary`
- `landscape-secondary`
- `portrait`
- `portrait-primary`
- `portrait-secondary`

```javascript
manifest.orientation = 'portrait';
Expand All @@ -209,8 +209,8 @@ manifest.orientation = 'portrait';
Possible values:

- true
- false
- `true`
- `false`

```javascript
manifest.prefer_related_applications = true;
Expand Down Expand Up @@ -345,15 +345,15 @@ manifest = {

> Sets the style of the status bar for a web application in iOS
See [Changing the Status Bar Appearance](https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html#//apple_ref/doc/uid/TP40002051-CH3-SW1)
See [Changing the Status Bar Appearance](https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariWebContent/ConfiguringWebApplications/ConfiguringWebApplications.html#//apple_ref/doc/uid/TP40002051-CH3-SW1).

Possible values:

- `default` The status bar appears normal.
- `black` The status bar has a black background.
- `black-translucent` The status bar is black and translucent.

Note that if set to default or black, the web content is displayed below the status bar. If set to black-translucent, the web content is displayed on the entire screen, partially obscured by the status bar.
Note that if set to `default` or `black`, the web content is displayed below the status bar. If set to `black-translucent`, the web content is displayed on the entire screen, partially obscured by the status bar.

```javascript
manifest.apple = {
Expand All @@ -372,7 +372,7 @@ manifest.apple = {

> Adds `precomposed` suffix to Apple touch icons
See [Precomposed Keyword for Apple touch icons](https://mathiasbynens.be/notes/touch-icons#effects)
See [Precomposed Keyword for Apple touch icons](https://mathiasbynens.be/notes/touch-icons#effects).

Possible values:

Expand All @@ -396,7 +396,7 @@ manifest.apple = {

> Adds `format-detection` meta tag if needed
See [Safari HTML Reference](https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html#//apple_ref/doc/uid/TP40008193-SW5)
See [Safari HTML Reference](https://developer.apple.com/library/content/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html#//apple_ref/doc/uid/TP40008193-SW5).

Possible values:

Expand All @@ -420,25 +420,21 @@ manifest.apple = {

## `ms` \*

> Turns on/off the generation of Microsoft-specific meta and link tags.
> Allows to configure the generation of Microsoft-specific `browserconfig.xml` manifest.
Possible values:

- An object with custom settings (see the settings below)

```javascript
manifest.ms = false;
```

### `ms.tileColor` \*

> Sets the `<TileColor>` property in `browserconfig.xml`.
See [Browser configuration schema reference](<https://msdn.microsoft.com/en-us/library/dn320426(v=vs.85).aspx>)
See [Browser configuration schema reference](<https://msdn.microsoft.com/en-us/library/dn320426(v=vs.85)>).

Possible values:

- A color in hex format.
- A color in `#hexadecimal` format.

```javascript
manifest.ms = {
Expand Down

0 comments on commit dc41d60

Please sign in to comment.