Naming a Plugin
There are five standard plugin naming conventions for Gatsby:
gatsby-source-*— a source plugin loads data from a given source (e.g. WordPress, MongoDB, the file system). Use this plugin type if you are connecting a new source of data to Gatsby.
gatsby-[plugin-name]-*— if a plugin is a plugin for another plugin 😅, it should be prefixed with the name of the plugin it extends (e.g. if it adds emoji to the output of
gatsby-transformer-remark, call it
gatsby-remark-add-emoji). Use this naming convention whenever your plugin will be included as a plugin in the
optionsobject of another plugin.
gatsby-theme-*— this naming convention is used for Gatsby themes, which are a type of plugin. This naming convention is used for plugins that own a section, a page, or part of a page on a site or expose files and components for shadowing.
gatsby-plugin-*— this is the most general plugin type. Use this naming convention if your plugin doesn’t meet the requirements of any other plugin types.
Edit this page on GitHubLast updated: