Gathering detailed insights and metrics for @emanueleperuffo/gatsby-plugin-netlify-cms
Gathering detailed insights and metrics for @emanueleperuffo/gatsby-plugin-netlify-cms
Gathering detailed insights and metrics for @emanueleperuffo/gatsby-plugin-netlify-cms
Gathering detailed insights and metrics for @emanueleperuffo/gatsby-plugin-netlify-cms
The best React-based framework with performance, scalability and security built in.
npm install @emanueleperuffo/gatsby-plugin-netlify-cms
Typescript
Module System
Node Version
NPM Version
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
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...
Updated on Oct 28, 2024
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%)
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
MIT License
55,910 Stars
21,738 Commits
10,289 Forks
719 Watchers
316 Branches
3,966 Contributors
Updated on Jul 16, 2025
Latest Version
2.0.0-beta.2
Package Id
@emanueleperuffo/gatsby-plugin-netlify-cms@2.0.0-beta.2
Unpacked Size
14.78 kB
Size
4.81 kB
File Count
10
NPM Version
6.1.0
Node Version
9.11.2
Cumulative downloads
Total Downloads
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
6
2
5
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.
1npm install --save netlify-cms gatsby-plugin-netlify-cms
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
.
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:
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:
1import CMS from `netlify-cms` 2 3/** 4 * Let's say you've created widget and preview components for a custom image 5 * gallery widget in separate files: 6 */ 7import ImageGalleryWidget from `./image-gallery-widget.js` 8import ImageGalleryPreview from `./image-gallery-preview.js` 9 10/** 11 * Register the imported widget: 12 */ 13CMS.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
:
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, { init } from `netlify-cms` 2 3/** 4 * Optionally pass in a config object. This object will be merged into `config.yml` if it exists 5 */ 6 7init({ 8 config: { 9 backend: { 10 name: 'git-gateway', 11 }, 12 }, 13})
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.
1plugins: [ 2 { 3 resolve: `gatsby-plugin-netlify-cms`, 4 options: { 5 enableIdentityWidget: true, 6 }, 7 }, 8]
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).
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 stylesPath: `path/to/styles.sass`, // default: undefined 7 enableIdentityWidget: `true`, 8 publicPath: `admin`, 9 htmlTitle: `Content Manager`, 10 }, 11 }, 12]
For help with integrating Netlify CMS with Gatsby, check out the community Gitter.
No vulnerabilities found.
Reason
security policy file detected
Details
Reason
no dangerous workflow patterns detected
Reason
GitHub workflow tokens follow principle of least privilege
Details
Reason
license file detected
Details
Reason
no binaries found in the repo
Reason
Found 20/25 approved changesets -- score normalized to 8
Reason
8 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 8
Reason
SAST tool is not run on all commits -- score normalized to 8
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
100 existing vulnerabilities detected
Details
Score
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