Skip to content

Commit

Permalink
fix(docs): update broken link, improve readability, add note about ab…
Browse files Browse the repository at this point in the history
…solute… (#10869)
  • Loading branch information
amberleyromo authored and pieh committed Jan 8, 2019
1 parent 4e013be commit b0adb15
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/docs/submit-to-plugin-library.md
Expand Up @@ -2,13 +2,21 @@
title: Submit to Plugin Library
---

#### Publishing a plugin to the library
## Publishing a plugin to the library

In order to add your plugin to the [Plugin Library](/plugins/), you need to publish a package to npm (learn how [here](https://docs.npmjs.com/getting-started/publishing-npm-packages)) with the [required files](#what-files-does-gatsby-look-for-in-a-plugin) and **include a `keywords` field** to `package.json` containing `gatsby` and `gatsby-plugin`.
In order to add your plugin to the [Plugin Library](/plugins/), you need to:

1. publish a package to npm (learn how [here](https://docs.npmjs.com/getting-started/publishing-npm-packages)),
2. include the [required files](/docs/plugin-authoring/#what-files-does-gatsby-look-for-in-a-plugin) in your plugin code,
3. and **include a `keywords` field** in your plugin's `package.json`, containing `gatsby` and `gatsby-plugin`.

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!

**NOTE:** 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:
## Notes

### Keywords

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:

```json:title=package.json
"keywords": [
Expand All @@ -19,3 +27,7 @@ After doing so, Algolia will take up to 12 hours to add it to the library search
"markdown",
]
```

### Images

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.

0 comments on commit b0adb15

Please sign in to comment.