npmpackage.info

Gathering detailed insights and metrics for gatsby-plugin-netlify-cms

Other packages similar to gatsby-plugin-netlify-cms

gatsby-plugin-netlify-cms-paths

1.3.0

A gatsby plugin to change file paths in your markdown files to Gatsby-friendly paths when using Netlify CMS to edit them.

gatsby-plugin-static-cms

4.0.0

A Gatsby plugin which generates the Static CMS single page app

@emanueleperuffo/gatsby-plugin-netlify-cms

2.0.0-beta.2

A Gatsby plugin which generates the Netlify CMS single page app

@talves/gatsby-plugin-netlify-cms

2.5.0

A plugin to use NetlifyCMS with React as peer dep

Gathering detailed insights and metrics for gatsby-plugin-netlify-cms

gatsby-plugin-netlify-cms - 7.12.1 | npmpackage.info

gatsby-plugin-netlify-cms

The best React-based framework with performance, scalability and security built in.

7.12.1

55,909

MIT

JavaScript

78.71 kB

6.7

Installations

npm install gatsby-plugin-netlify-cms

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=18.0.0

Node Version

18.14.0

NPM Version

lerna/3.22.1/node@v18.14.0+arm64 (darwin)

Pull Requests

Open

213

Total

22,353

Closed

3,970

Merged

18,170

Issues

Open

216

Total

14,114

Closed

13,898

Releases

149

gatsby-source-shopify@9.0.0

Updated on Jan 07, 2025

gatsby-link@5.14.1

Updated on Jan 07, 2025

gatsby-source-contentful@8.15.0

Updated on Jan 07, 2025

v5.14.0

gatsby@5.14.0

Updated on Nov 06, 2024

gatsby-source-shopify@8.13.2

Updated on Oct 28, 2024

gatsby-source-wordpress@7.13.5 and 6 more...

gatsby-source-wordpress@7.13.5

Updated on Oct 28, 2024

View All 149 releases

Languages

JavaScript

TypeScript

CSS

HTML

MDX

Shell

Dockerfile

PHP

EJS

Python

Less

SCSS

Stylus

JavaScript (58.91%)

TypeScript (38.71%)

CSS (1.05%)

HTML (0.69%)

MDX (0.45%)

Shell (0.13%)

Dockerfile (0.03%)

PHP (0.02%)

EJS (0.01%)

Developer

gatsbyjs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

55,909 Stars

21,738 Commits

10,289 Forks

719 Watchers

316 Branches

3,966 Contributors

Updated on Jul 15, 2025

Maintainers

View All 3,966 Contributors

Package Meta Information

Latest Version

7.12.1

Package Id

gatsby-plugin-netlify-cms@7.12.1

Unpacked Size

78.71 kB

Size

16.11 kB

File Count

NPM Version

lerna/3.22.1/node@v18.14.0+arm64 (darwin)

Node Version

18.14.0

Published on

Dec 14, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

⚠️ This package is now deprecated

The gatsby-plugin-netlify-cms package is now deprecated. This plugin has been renamed and moved to Decap CMS. See gatsby-plugin-decap-cms for more information.

gatsby-plugin-netlify-cms

Gatsby v1 and Netlify CMS 1.x require gatsby-plugin-netlify-cms@^2.0.0.

Gatsby v2 and Netlify CMS 2.x require gatsby-plugin-netlify-cms@^3.0.0.

Gatsby v2 and Netlify CMS (netlify-cms-app) 2.9.x required gatsby-plugin-netlify-cms@^4.0.0, which is documented below.

Overview

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.

Note: gatsby-plugin-netlify-cms@^4.0.0 changes the requirement for Netlify CMS to use a new library published netlify-cms-app@^2.9.x and is a breaking change.

Install

1npm install netlify-cms-app gatsby-plugin-netlify-cms

How to use

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

1plugins: [`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, type: string | Array<string>, 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. Any styles imported by this module (or by the modules that it imports, all the way down the chain) are automatically applied to the editor preview pane by the plugin.

1plugins: [
2  {
3    resolve: `gatsby-plugin-netlify-cms`,
4    options: {
5      /**
6       * One convention is to place your Netlify CMS customization code in a
7       * `src/cms` directory.
8       */
9      modulePath: `${__dirname}/src/cms/cms.js`,
10    },
11  },
12]

The js module might look like this:

1/**
2 * The default export of `netlify-cms-app` is an object with all of the Netlify CMS
3 * extension registration methods, such as `registerWidget` and
4 * `registerPreviewTemplate`.
5 */
6import CMS from "netlify-cms-app"
7
8/**
9 * Any imported styles should be automatically be applied to the editor preview
10 * pane thus eliminating the need to use `registerPreviewStyle` for imported
11 * styles. However if you are experiencing build errors regarding importing css,
12 * sass or scss into a cms module when deploying to the netlify platform, you
13 * may need to follow the implementation found in netlify documentation here:
14 * https://www.netlifycms.org/docs/beta-features/#raw-css-in-registerpreviewstyle
15 * All of the example imports below would result in styles being applied to the
16 * preview pane.
17 */
18import "module-that-imports-styles.js"
19import "styles.scss"
20import "../other-styles.css"
21
22/**
23 * Let's say you've created widget and preview components for a custom image
24 * gallery widget in separate files:
25 */
26import ImageGalleryWidget from "./image-gallery-widget.js"
27import ImageGalleryPreview from "./image-gallery-preview.js"
28
29/**
30 * Register the imported widget:
31 */
32CMS.registerWidget(`image-gallery`, ImageGalleryWidget, ImageGalleryPreview)

`manualInit`

(optional, type: boolean, 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:

1plugins: [
2  {
3    resolve: `gatsby-plugin-netlify-cms`,
4    options: {
5      manualInit: true,
6    },
7  },
8]

The js module might look like this:

1import CMS from "netlify-cms-app"
2
3/**
4 * Optionally pass in a config object. This object will be merged into `config.yml` if it exists
5 */
6
7CMS.init({
8  config: {
9    backend: {
10      name: "git-gateway",
11    },
12  },
13})

`enableIdentityWidget`

(optional, type: boolean, default: true)

enableIdentityWidget is true by default, allowing Netlify Identity to be used without configuration. Disable it when not using Netlify Identity to reduce bundle size.

1plugins: [
2  {
3    resolve: `gatsby-plugin-netlify-cms`,
4    options: {
5      enableIdentityWidget: true,
6    },
7  },
8]

`publicPath`

(optional, type: string, default: "admin")

Customize the path to Netlify CMS on your Gatsby site.

`htmlTitle`

(optional, type: string, default: Content Manager)

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

`htmlFavicon`

(optional, type: string, default: "")

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

`includeRobots`

(optional, type: boolean, default: false)

By default, the CMS page is not indexed by crawlers. Use this to add a meta tag to invite robots to index the CMS page.

`customizeWebpackConfig`

(optional, type: function)

Function to customize webpack configuration.

Function parameters:

config: webpack configuration for NetlifyCMS
destructured object from onCreateWebpackConfig { store, stage, pathPrefix, getConfig, rules, loaders, plugins} as seen in https://www.gatsbyjs.com/docs/node-apis/#onCreateWebpackConfig

1plugins: [
2  {
3    resolve: `gatsby-plugin-netlify-cms`,
4    options: {
5      customizeWebpackConfig: (config, { plugins }) => {
6        const Plugin = require("...")
7
8        config.plugins.push(
9          plugins.define({
10            "process.env.MY_VAR": JSON.stringify("my var value"),
11          })
12        )
13
14        config.plugins.push(new Plugin())
15      },
16    },
17  },
18]

Example

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

1plugins: [
2  {
3    resolve: `gatsby-plugin-netlify-cms`,
4    options: {
5      modulePath: `path/to/custom/script.js`, // default: undefined
6      enableIdentityWidget: true,
7      publicPath: `admin`,
8      htmlTitle: `Content Manager`,
9      htmlFavicon: `path/to/favicon`,
10      includeRobots: false,
11    },
12  },
13]

Disable widget on site

If you're not using Netlify Identity within your site you have the option to completely disable the widget (and not the CMS). To do so, add the following to gatsby-node.js:

1const webpack = require(`webpack`)
2
3exports.onCreateWebpackConfig = ({ actions }) => {
4  actions.setWebpackConfig({
5    plugins: [
6      new webpack.IgnorePlugin({
7        resourceRegExp: /^netlify-identity-widget$/,
8      }),
9    ],
10  })
11}

Support

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

No vulnerabilities found.

10

Security-Policy

Determines if the project has published a security policy.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

License

Determines if the project has defined a license.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

8

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

8

Maintained

Determines if the project is "actively maintained".

8

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/schedule-stale.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/gatsbyjs/gatsby/schedule-stale.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/schedule-stale.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/gatsbyjs/gatsby/schedule-stale.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/schedule-stale.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/gatsbyjs/gatsby/schedule-stale.yml/master?enable=pin
Warn: containerImage not pinned by hash: .github/actions/gatsby-site-showcase-validator/Dockerfile:1: pin your Docker image by updating node:10-slim to node:10-slim@sha256:88932859e3d022d79161b99628c4c2c50e836437455e2d1b1a008d98367b10d6
Warn: containerImage not pinned by hash: .github/actions/high-priority-prs/Dockerfile:1: pin your Docker image by updating node:10-slim to node:10-slim@sha256:88932859e3d022d79161b99628c4c2c50e836437455e2d1b1a008d98367b10d6
Warn: containerImage not pinned by hash: .gitpod.Dockerfile:1: pin your Docker image by updating gitpod/workspace-full to gitpod/workspace-full@sha256:b1195dfae7ee9a12a89d195247c3e1357cc6a18360a41473dbec67525ef434e2
Warn: containerImage not pinned by hash: benchmarks/docker-runner/Dockerfile:1: pin your Docker image by updating node:14-buster to node:14-buster@sha256:a158d3b9b4e3fa813fa6c8c590b8f0a860e015ad4e59bbce5744d2f6fd8461aa
Warn: containerImage not pinned by hash: integration-tests/gatsby-source-wordpress/docker/wordpress/Dockerfile:1: pin your Docker image by updating wordpress:6.1 to wordpress:6.1@sha256:6991d7aea34c9746ab76ab22bcccdedc3594d37a148e08161c29b128bd50294c
Warn: containerImage not pinned by hash: integration-tests/gatsby-source-wordpress/docker/wp-cli/Dockerfile:1: pin your Docker image by updating wordpress:cli-php7.4 to wordpress:cli-php7.4@sha256:946a8b7f237f6cf90d8f04aff952544a0332d43374d598925dcf0180e4441c6c
Warn: npmCommand not pinned by hash: .gitpod.Dockerfile:8
Warn: npmCommand not pinned by hash: benchmarks/docker-runner/Dockerfile:6
Warn: npmCommand not pinned by hash: examples/build-all-examples.sh:34
Warn: npmCommand not pinned by hash: scripts/e2e-test.sh:17
Warn: npmCommand not pinned by hash: scripts/e2e-test.sh:17
Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 1 third-party GitHubAction dependencies pinned
Info: 0 out of 6 containerImage dependencies pinned
Info: 1 out of 6 npmCommand dependencies pinned

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

100 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6
Warn: Project is vulnerable to: GHSA-xq7p-g2vc-g82p
Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
Warn: Project is vulnerable to: GHSA-rv95-896h-c2vc
Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
Warn: Project is vulnerable to: GHSA-9pv7-vfvm-6vr7
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488
Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-7hpj-7hhx-2fgx
Warn: Project is vulnerable to: GHSA-44fp-w29j-9vj5
Warn: Project is vulnerable to: GHSA-4pg4-qvpc-4q3h
Warn: Project is vulnerable to: GHSA-g5hg-p3ph-g8qg
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-rhx6-c78j-4q9w
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-x7hr-w5r2-h6wg
Warn: Project is vulnerable to: GHSA-rm97-x556-q36h
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-pq67-2wwv-3xjx
Warn: Project is vulnerable to: GHSA-8cj5-5rvv-wf4v
Warn: Project is vulnerable to: GHSA-4vvj-4cpr-p986
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-f9xv-q969-pqx4
Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp
Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-whgm-jr23-g3j9
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-wg6g-ppvx-927h
Warn: Project is vulnerable to: GHSA-7gc6-qh9x-w6h8
Warn: Project is vulnerable to: GHSA-8gh8-hqwg-xf34
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546
Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33
Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959
Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6
Warn: Project is vulnerable to: GHSA-3wc5-fcw2-2329
Warn: Project is vulnerable to: GHSA-64fm-8hw2-v72w
Warn: Project is vulnerable to: GHSA-f98w-7cxr-ff2h
Warn: Project is vulnerable to: GHSA-cg87-wmx4-v546
Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq
Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-8g77-54rh-46hx
Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-rxrc-rgv4-jpvx
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-w5p7-h5w8-2hfq
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-fhg7-m89q-25r3
Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
Warn: Project is vulnerable to: GHSA-g78m-2chm-r7qv
Warn: Project is vulnerable to: GHSA-4r6h-8v6p-xvw6
Warn: Project is vulnerable to: GHSA-5pgg-2g8v-p4x9
Warn: Project is vulnerable to: GHSA-h6q6-9hqw-rwfv
Warn: Project is vulnerable to: GHSA-5fg8-2547-mr8q
Warn: Project is vulnerable to: GHSA-crh6-fp67-6883
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh

Score

6.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to gatsby-plugin-netlify-cms

Other packages similar to gatsby-plugin-netlify-cms

gatsby-plugin-netlify-cms

Installations

Developer Guide

No

CommonJS

>=18.0.0

18.14.0

lerna/3.22.1/node@v18.14.0+arm64 (darwin)

Pull Requests

213

22,353

3,970

18,170

Issues

216

14,114

13,898

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

⚠️ This package is now deprecated

gatsby-plugin-netlify-cms

Overview

Install

How to use

Options

modulePath

manualInit

enableIdentityWidget

publicPath

htmlTitle

htmlFavicon

includeRobots

customizeWebpackConfig

Example

Disable widget on site

Support

10

10

10

10

10

8

8

8

0

0

0

0

6.7

/10

`modulePath`

`manualInit`

`enableIdentityWidget`

`publicPath`

`htmlTitle`

`htmlFavicon`

`includeRobots`

`customizeWebpackConfig`