From 66ca3aeb48588ea9df74375b3ace46242c022744 Mon Sep 17 00:00:00 2001 From: Alex Moon Date: Fri, 20 Sep 2019 09:19:08 +0000 Subject: [PATCH] docs: add apendix indicating options are validated and version of spec they adhear to. --- packages/gatsby-plugin-manifest/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages/gatsby-plugin-manifest/README.md b/packages/gatsby-plugin-manifest/README.md index 4f9eeca4e2c31..65261ef924a30 100644 --- a/packages/gatsby-plugin-manifest/README.md +++ b/packages/gatsby-plugin-manifest/README.md @@ -416,6 +416,12 @@ manifest—https://developers.google.com/web/fundamentals/engage-and-retain/web- For more information see the w3 spec https://www.w3.org/TR/appmanifest/ or Mozilla docs https://developer.mozilla.org/en-US/docs/Web/Manifest. +### Plugin options validation + +This plugin validates plugin options set in the `gatsby-config.js`. It validates the options used by the plugin and the entire WebAppManifest spec. To see the exact implemntation of the validator see [src/plugin-options.js](src/plugin-options.js). + +The WebAppManifest spec is not stable at the time of writing. This version of the validator adhears the [most recent](https://www.w3.org/TR/2019/WD-appmanifest-20190911/) version of the specification available. + ## Troubleshooting ### Incompatible library version: sharp.node requires version X or later, but Z provides version Y