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

chore(docs): Add note about icon_options #28363

Merged
merged 1 commit into from
Nov 30, 2020
Merged
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
5 changes: 3 additions & 2 deletions packages/gatsby-plugin-manifest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,8 @@ module.exports = {
display: `standalone`,
icon: `src/images/icon.png`,
icon_options: {
// For all the options available, please see the additional resources below.
// For all the options available,
// please see the section "Additional Resources" below.
purpose: `any maskable`,
},
},
Expand Down Expand Up @@ -444,7 +445,7 @@ Internet Explorer is the only other major browser that doesn't support the web a
This article from the Chrome DevRel team is a good intro to the web app
manifest — https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/

For more information, see the [W3C specification](https://www.w3.org/TR/appmanifest/), [Mozilla documentation](https://developer.mozilla.org/en-US/docs/Web/Manifest) or [Web.Dev guide](https://web.dev/add-manifest/).
For more information, see the [W3C specification](https://www.w3.org/TR/appmanifest/), [Mozilla documentation](https://developer.mozilla.org/en-US/docs/Web/Manifest) or [Web.Dev guide](https://web.dev/add-manifest/). More information about `icon_options` can be found in [this Web.Dev guide](https://web.dev/maskable-icon/).

### Plugin options validation

Expand Down