Backends Overview

Overview A backend is JavaScript code that allows Netlify CMS to communicate with a service that stores content – typically a Git host like GitHub or GitLab. It provides functions that Netlify CMS can use to do things like read and update files using API’s provided by the service. Backend Configuration Individual backends should provide …

Take a test drive

You can easily try out Netlify CMS by running it on a pre-configured starter site. Our example in the intro is the Kaldi small business Hugo template. Use the deploy button below to build and deploy your own copy of the repository: Deploy to Netlify. Authenticate with GitHub When the deploy completes, you can see …

Creating Custom Widgets

The NetlifyCMS exposes a window.CMS a global object that you can use to register custom widgets, previews, and editor plugins. The same object is also the default export if you import Netlify CMS as an npm module. The available widget extension methods are: registerWidget: registers a custom widget. registerEditorComponent: adds a block component to the …

GitHub

For repositories stored on GitHub, the github backend allows CMS users to log in directly with their GitHub account. Note that all users must have push access to your content repository for this to work. Because Github requires a server for authentication, Netlify facilitates basic GitHub authentication. To enable basic GitHub authentication: Follow the authentication …

Site Generator Overview

Overview The process for adding Netlify CMS to a static site can be divided into four main steps: Install Netlify CMS This is a single page app available at the /admin route of your website. Check out the general overview to see what the installation process entails. Set up a backend This serves two purpose: …

Creating Custom Previews

The NetlifyCMS exposes a window.CMS global object that you can use to register custom widgets, previews and editor plugins. The available customization methods are: registerPreviewStyle: Register a custom stylesheet to use on the preview pane. registerPreviewTemplate: Registers a template for a collection. React Components inline interaction NetlifyCMS is a collection of React components and exposes …