/netlify-cms

A CMS for Static Site Generators

Primary LanguageJavaScriptMIT LicenseMIT

Netlify CMS

A CMS for static site generators. Give users a simple way to edit and add content to any site built with a static site generator.

About this fork

This is a fork of Netlify CMS modified for specific CFPB use cases, notably for use with our Design System. To update this fork with changes from upstream, try using GitHub's interface. To add features to this fork, follow these steps.

How It Works

Netlify CMS is a single-page app that you pull into the /admin part of your site.

It presents a clean UI for editing content stored in a Git repository.

You setup a YAML config to describe the content model of your site, and typically tweak the main layout of the CMS a bit to fit your own site.

When a user navigates to /admin/ they'll be prompted to log in, and once authenticated they'll be able to create new content or edit existing content.

Read more about Netlify CMS Core Concepts.

Installation and Configuration

The Netlify CMS can be used in two different ways.

  • A Quick and easy install, that requires you to create a single HTML file and a configuration file. All the CMS JavaScript and CSS are loaded from a CDN. To learn more about this installation method, refer to the Quick Start Guide
  • A complete, more complex install, that gives you more flexibility but requires that you use a static site builder with a build system that supports npm packages.

Contributing

New contributors are always welcome! Check out CONTRIBUTING.md to get involved.

Change Log

This project adheres to Semantic Versioning. Every release is documented on the Github Releases page.

License

Netlify CMS is released under the MIT License. Please make sure you understand its implications and guarantees.

Thanks

Services

These services support Netlify CMS development by providing free infrastructure.

travis-ci browserstack Cypress.io