Skip to main content
Community Plugin
View plugin on GitHub
See starters using this

gatsby-plugin-netlify-cms

Automatically generates an admin/index.html with a default Netlify CMS implementation.

Netlify CMS is a React single page app for editing git based content via API. Its built for non-technical and technical editors alike, and its super easy to install and configure. For more details, check out the docs site.

Install

npm install --save netlify-cms gatsby-plugin-netlify-cms

How to use

Add the Netlify CMS plugin in your gatsby-config.js:

plugins: [`gatsby-plugin-netlify-cms`]

Then add your Netlify CMS configuration file in static/admin/config.yml.

Options

Netlify CMS can be configured via the plugin options below. You can learn about how to pass options to plugins in the Gatsby docs.

modulePath

(optional, default: undefined)

If you need to customize Netlify CMS, e.g. registering custom widgets or styling the preview pane, you’ll need to do so in a JavaScript module and provide Gatsby with the path to your module via the modulePath option:

plugins: [
  {
    resolve: `gatsby-plugin-netlify-cms`,
    options: {
      /**
       * One convention is to place your Netlify CMS customization code in a
       * `src/cms` directory.
       */
      modulePath: `${__dirname}/src/cms/cms.js`,
    },
  },
]

The js module might look like this:

import CMS from `netlify-cms`

/**
 * Let's say you've created widget and preview components for a custom image
 * gallery widget in separate files:
 */
import ImageGalleryWidget from `./image-gallery-widget.js`
import ImageGalleryPreview from `./image-gallery-preview.js`

/**
 * Register the imported widget:
 */
CMS.registerWidget(`image-gallery`, ImageGalleryWidget, ImageGalleryPreview)

manualInit

(optional, default: false)

Set this to true If you need to manually initialize Netlify CMS. The plugin will take care of setting window.CMS_MANUAL_INIT to true:

plugins: [
  {
    resolve: `gatsby-plugin-netlify-cms`,
    options: {
      manualInit: true,
    },
  },
]

The js module might look like this:

import CMS, { init } from `netlify-cms`

/**
 * Optionally pass in a config object. This object will be merged into `config.yml` if it exists
 */

init({
  config: {
    backend: {
      name: 'git-gateway',
    },
  },
})

enableIdentityWidget

(optional, default: true)

enableIdentityWidget is true by default, allowing Netlify Identity to be used without configuration, but you may need to disable it in some cases, such as when using a Netlify CMS backend that conflicts. This is currently known to be the case when using the GitLab backend, but only when using implicit OAuth.

plugins: [
  {
    resolve: `gatsby-plugin-netlify-cms`,
    options: {
      enableIdentityWidget: true,
    },
  },
]

stylesPath

(optional, default: undefined)

Gatsby template components can be used as preview templates in Netlify CMS. To apply your site styles to the preview pane as well, you would normally register a custom stylesheet, but your Gatsby style source may be Sass or CSS modules, and can’t be passed to Netlify CMS as is. The stylesPath accepts a path or an array of paths to your raw styles. The styles are built using the same Webpack and Babel configuration that your Gatsby site uses, and the CSS output is automatically registered and used in the preview pane.

publicPath

(optional, default: "admin")

Customize the path to Netlify CMS on your Gatsby site.

htmlTitle

(optional, default: Content Manager)

Customize the value of the title tag in your CMS HTML (shows in the browser bar).

Example

Here is the plugin with example values for all options (note that no option is required):

plugins: [
  {
    resolve: `gatsby-plugin-netlify-cms`,
    options: {
      modulePath: `path/to/custom/script.js`, // default: undefined
      stylesPath: `path/to/styles.sass`, // default: undefined
      enableIdentityWidget: `true`,
      publicPath: `admin`,
      htmlTitle: `Content Manager`,
    },
  },
]

Support

For help with integrating Netlify CMS with Gatsby, check out the community Gitter.