/static-cms

A Git-based CMS for Static Site Generators

Primary LanguageTypeScriptMIT LicenseMIT

GitHub license Build npm latest package PRs Welcome All Contributors

Docs | Demo | Issues | Discord

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.

How It Works

Static 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 Static CMS Core Concepts.

Installation and Configuration

The Static 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 CDN Hosting 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. To learn more about this installation method, refer to the Bundling Guide

Projects

Name Site/Demo Status
@staticcms/core demo.staticcms.org Build npm latest package
@staticcms/app demo.staticcms.org Build npm latest package
demo demo.staticcms.org Netlify Status
docs staticcms.org Netlify Status

Platform Templates

Name Demo Status
Next - static-cms-next-netlify-template next.staticcms.org Netlify Status
Gatsby - static-cms-gatsby-netlify-template gatsby.staticcms.org Netlify Status
Hugo - static-cms-hugo-netlify-template hugo.staticcms.org Netlify Status
Nuxt - static-cms-nuxt-netlify-template nuxt.staticcms.org Netlify Status
Preact - static-cms-preact-netlify-template preact.staticcms.org Netlify Status
Eleventy - static-cms-eleventy-netlify-template eleventy.staticcms.org Netlify Status

Workflow Templates

Name Demo Status
Editorial Workflow Template Production: next-editorial.staticcms.org
Staging: next-editorial-staging.staticcms.org
Netlify Status
Netlify Status

Other Projects

Name Status
static-cms-proxy-server Build and Test npm latest package
gatsby-plugin-static-cms Build npm latest package

Sponsors

slickduck
Slick Duck

Contributing

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

Contributors

Daniel Lautzenheiser
Daniel Lautzenheiser

💻 📖 🎨 🚧
Denys Konovalov
Denys Konovalov

💻 📖
Frank Elsinga
Frank Elsinga

💻 📖
Skrubbadubba
Skrubbadubba

📖
a-kriya
a-kriya

📖
Andreas Wagner
Andreas Wagner

📖
McFlyPartages
McFlyPartages

📖
robigan
robigan

📖
Mildred Ki'Lya
Mildred Ki'Lya

💻
Avi Charlop
Avi Charlop

📖
dominiclooser
dominiclooser

📖

Change Log

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

License

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

Netlify CMS

Static CMS is a fork of Netlify CMS focusing on the core product over adding massive, scope expanding, new features.