Skip to main content

Naming a Plugin

Plugin title naming conventions

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-transformer-* β€” a transformer plugin converts data from one format (e.g. CSV, YAML) to a JavaScript object. Use this naming convention if your plugin will be transforming data from one format to another.
  • 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 options object 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 GitHub
Docs
Tutorials
Plugins
Blog
Showcase