Submit to Plugin Library
Publishing a plugin to the library
In order to add your plugin to the Plugin Library, you need to:
- Publish a package to npm (learn how on the npm docs).
- Include the required files in your plugin code.
- Include a
keywordsfield in your plugin’s
gatsby-plugin. If your plugin is a theme, please also include
- Document your plugin with a README, using the contributing plugin template for reference.
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://www.gatsbyjs.com to automatically include your plugin page to the website. Then, all you have to do is share your wonderful plugin with the community!
You can include other relevant keywords to your
package.json file to help interested users in finding it. As an example, a Markdown MathJax transformer would include:
If you include images in your plugin repo’s README, please make sure you are referencing the image using an absolute URL in order for the image to show on your plugin page.