Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Markdown][Web/Manifest] Convert Web/Manifest to Markdown - DO NOT SQUASH MERGE #9723

Merged
merged 2 commits into from
Oct 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 0 additions & 43 deletions files/en-us/web/manifest/background_color/index.html

This file was deleted.

43 changes: 43 additions & 0 deletions files/en-us/web/manifest/background_color/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: background_color
slug: Web/Manifest/background_color
tags:
- Manifest
- Web
- background_color
browser-compat: html.manifest.background_color
---
{{QuickLinksWithSubpages("/en-US/docs/Web/Manifest")}}

<table class="properties">
<tbody>
<tr>
<th scope="row">Type</th>
<td><code>String</code></td>
</tr>
<tr>
<th scope="row">Mandatory</th>
<td>No</td>
</tr>
</tbody>
</table>

The `background_color` member defines a placeholder background color for the application page to display before its stylesheet is loaded. This value is used by the user agent to draw the background color of a shortcut when the manifest is available before the stylesheet has loaded.

Therefore `background_color` should match the {{cssxref("background-color")}} CSS property in the site’s stylesheet for a smooth transition between launching the web application and loading the site's content.

> **Note:** The `background_color` member is only meant to improve the user experience while the main stylesheet is loading from the network or the storage media; it is not used by the user agent as the {{cssxref("background-color")}} CSS property when the progressive web app stylesheet is available.

## Examples

```json
"background_color": "red"
```

## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}
46 changes: 0 additions & 46 deletions files/en-us/web/manifest/categories/index.html

This file was deleted.

43 changes: 43 additions & 0 deletions files/en-us/web/manifest/categories/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: categories
slug: Web/Manifest/categories
tags:
- Manifest
- Web
- categories
browser-compat: html.manifest.categories
---
{{QuickLinksWithSubpages("/en-US/docs/Web/Manifest")}}

<table class="properties">
<tbody>
<tr>
<th scope="row">Type</th>
<td><code>Array</code> of <code>String</code>s</td>
</tr>
<tr>
<th scope="row">Mandatory</th>
<td>No</td>
</tr>
</tbody>
</table>

The _`categories`_ member is an array of strings defining the names of categories that the application supposedly belongs to. There is no standard list of possible values, but the W3C maintains [a list of known categories](https://github.com/w3c/manifest/wiki/Categories).

> **Note:** `categories` are used only as hints for catalogs or stores listing web applications. Like search engines and meta keywords, catalogs and stores are free to ignore them.

> **Note:** `categories` values are lower-cased by the stores and catalogs before processing, so "News" and "news" are treated as the same value. Developers are encouraged to use lower case in the first place.

## Example

```json
"categories": ["books", "education", "medical"]
```

## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}
45 changes: 0 additions & 45 deletions files/en-us/web/manifest/description/index.html

This file was deleted.

49 changes: 49 additions & 0 deletions files/en-us/web/manifest/description/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: description
slug: Web/Manifest/description
tags:
- Manifest
- Web
- description
browser-compat: html.manifest.description
---
{{QuickLinksWithSubpages("/en-US/docs/Web/Manifest")}}

<table class="properties">
<tbody>
<tr>
<th scope="row">Type</th>
<td><code>String</code></td>
</tr>
<tr>
<th scope="row">Mandatory</th>
<td>No</td>
</tr>
</tbody>
</table>

The _`description`_ member is a string in which developers can explain what the application does. `description` is directionality-capable, which means it can be displayed left to right or right to left based on the values of the [`dir`](/en-US/docs/Web/Manifest/dir) and [`lang`](/en-US/docs/Web/Manifest/lang) manifest members.

## Examples

Simple `description` in left-to-right language:

```json
"description": "Awesome application that will help you achieve your dreams."
```

`description` in Arabic, which will be displayed right-to-left:

```json
"dir": "rtl",
"lang": "ar",
"description": ".تطبيق رائع سيساعدك على تحقيق أحلامك"
```

## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}
59 changes: 0 additions & 59 deletions files/en-us/web/manifest/dir/index.html

This file was deleted.

55 changes: 55 additions & 0 deletions files/en-us/web/manifest/dir/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: dir
slug: Web/Manifest/dir
tags:
- Manifest
- Web
- dir
browser-compat: html.manifest.dir
---
{{QuickLinksWithSubpages("/en-US/docs/Web/Manifest")}}

<table class="properties">
<tbody>
<tr>
<th scope="row">Type</th>
<td><code>String</code></td>
</tr>
<tr>
<th scope="row">Mandatory</th>
<td>No</td>
</tr>
</tbody>
</table>

The base direction in which to display direction-capable members of the manifest. Together with the [`lang`](/en-US/docs/Web/Manifest/lang) member, it helps to correctly display right-to-left languages.

The `dir` member can be set to one of the following values:

- `auto` — text direction is determined by the user agent
- `ltr` — left to right
- `rtl` — right to left

The _directionality-capable members_ are:

- [`name`](/en-US/docs/Web/Manifest/name)
- [`short_name`](/en-US/docs/Web/Manifest/short_name)
- [`description`](/en-US/docs/Web/Manifest/description)

> **Note:** If the value is omitted or set to `auto`, the browser will use the [Unicode bidirectional algorithm](/en-US/docs/Web/Guide/Unicode_Bidrectional_Text_Algorithm) to make a best guess about the text's direction.

## Example

```json
"dir": "rtl",
"lang": "ar",
"short_name": "!أنا من التطبيق"
```

## Specifications

{{Specifications}}

## Browser compatibility

{{Compat}}
Loading