Share Build Plugins
If you’d like to share your plugin with others, you can publish it to npm. All Netlify Build Plugins in the npm Public Registry can be installed by any Netlify user through file-based installation. Once your plugin is published to npm, you can make it available in the Netlify UI by submitting it to the Netlify plugins directory.
# Publish to npm
To publish a Build Plugin to npm, follow npm’s documentation for contributing packages to the registry.
Be sure to add the following properties to your plugin’s package.json
file:
name
should start withnetlify-plugin-
(such asnetlify-plugin-example
or@scope/netlify-plugin-example
). It should match the pluginname
field. It is recommended for the plugin repository to be named like this as well.keywords
should contain thenetlify
andnetlify-plugin
keywords. The same applies to GitHub topics. This helps users find your plugin.repository
andbugs
should be defined. Those are displayed to users when an error occurs inside your plugin.
# Submit to the plugins directory
The Netlify plugins directory is generated from a plugins.json
files stored in a public repository, https://github.com/netlify/plugins.
The repository includes a contributor guide with instructions for preparing your plugin and submitting it in a pull request to the repository. As noted in the guide, you’ll also need to read and follow the plugin author guidelines before submitting.
Did you find this doc useful?
Your feedback helps us improve our docs.