Skip to content

Commit c3177c2

Browse files
k-conwaygillkyle
authored andcommitted
docs(www): link to plugin README templates from plugins guide (#14856)
* update creating-plugins guide update creating-plugins guide to include plugin template link * move note where file links to README templates
1 parent f650924 commit c3177c2

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/contributing/submit-to-plugin-library.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ In order to add your plugin to the [Plugin Library](/plugins/), you need to:
88

99
1. publish a package to npm (learn how [here](https://docs.npmjs.com/getting-started/publishing-npm-packages)),
1010
2. include the [required files](/docs/files-gatsby-looks-for-in-a-plugin/) in your plugin code,
11-
3. and **include a `keywords` field** in your plugin's `package.json`, containing `gatsby` and `gatsby-plugin`.
11+
3. **include a `keywords` field** in your plugin's `package.json`, containing `gatsby` and `gatsby-plugin`,
12+
4. and document your plugin with a README, there are [plugin templates](/contributing/docs-templates/#plugin-readme-template) available to be used as reference.
1213

1314
After doing so, Algolia will take up to 12 hours to add it to the library search index (the exact time necessary is still unknown), and wait for the daily rebuild of https://gatsbyjs.org to automatically include your plugin page to the website. Then, all you have to do is share your wonderful plugin with the community!
1415

0 commit comments

Comments
 (0)