2022-09-30 08:34:29 -04:00
< div align = "center" >
2022-10-02 20:06:20 -04:00
< img src = "static-cms-logo.png" width = "500px" / >
2021-03-02 16:33:32 -06:00
2022-10-02 20:06:20 -04:00
[](https://github.com/StaticJsCMS/static-cms/blob/main/LICENSE)
2022-12-15 13:45:19 -05:00
[](https://github.com/StaticJsCMS/static-cms/actions/workflows/build.yml)
2022-10-02 20:06:20 -04:00
[](https://www.npmjs.com/package/@staticcms/core)
[](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md)
2023-01-18 11:22:06 -05:00
< div align = "center" >
2022-09-30 06:13:47 -06:00
2023-01-18 11:22:06 -05:00
[Docs ](https://staticcms.org/ )
| [Demo ](https://demo.staticcms.org/ )
| [Issues ](https://github.com/StaticJsCMS/static-cms/issues )
| [Discord ](https://discord.gg/ZWJM9pBMjj )
2021-03-02 16:33:32 -06:00
2023-01-18 11:22:06 -05:00
< / div >
< / div >
2019-10-22 21:11:49 -04:00
2023-01-17 12:12:16 -05:00
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.
2022-10-11 07:51:47 -04:00
2019-04-06 03:05:44 +05:00
## How It Works
2016-06-05 12:48:28 -07:00
2022-10-02 20:06:20 -04:00
Static CMS is a single-page app that you pull into the `/admin` part of your site.
2016-06-05 12:48:28 -07:00
It presents a clean UI for editing content stored in a Git repository.
2023-01-17 12:12:16 -05:00
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.
2016-06-05 12:48:28 -07:00
2023-01-17 12:12:16 -05:00
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.
2016-09-20 11:29:45 -03:00
2023-01-18 10:46:19 -05:00
Read more about Static CMS [Core Concepts ](https://staticcms.org/docs/intro/ ).
2016-09-20 11:29:45 -03:00
2017-02-08 16:29:15 -02:00
# Installation and Configuration
2016-09-20 11:29:45 -03:00
2022-10-02 20:06:20 -04:00
The Static CMS can be used in two different ways.
2016-09-20 11:29:45 -03:00
2023-01-17 12:12:16 -05:00
- 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.
2023-01-18 10:46:19 -05:00
To learn more about this installation method, refer to the [CDN Hosting Guide ](https://staticcms.org/docs/add-to-your-site-cdn/ )
2023-01-17 12:12:16 -05:00
- 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.
2023-01-18 10:46:19 -05:00
To learn more about this installation method, refer to the [Bundling Guide ](https://staticcms.org/docs/add-to-your-site-bundling/ )
2022-09-30 06:13:47 -06:00
2023-01-27 10:27:13 -05:00
# Projects
2023-01-27 10:57:25 -05:00
|Name|Site/Demo|Status|
|---|---|---|
| [@staticcms/core ](https://github.com/StaticJsCMS/static-cms/tree/main/packages/core ) | [demo.staticcms.org ](https://demo.staticcms.org/ ) | [](https://github.com/StaticJsCMS/static-cms/actions/workflows/build.yml) [](https://www.npmjs.com/package/@staticcms/core) |
| [@staticcms/app ](https://github.com/StaticJsCMS/static-cms/tree/main/packages/app ) | [demo.staticcms.org ](https://demo.staticcms.org/ ) | [](https://github.com/StaticJsCMS/static-cms/actions/workflows/build.yml) [](https://www.npmjs.com/package/@staticcms/app) |
| [demo ](https://github.com/StaticJsCMS/static-cms/tree/main/packages/demo ) | [demo.staticcms.org ](https://demo.staticcms.org/ ) | [](https://app.netlify.com/sites/demo-staticjscms/deploys) |
| [docs ](https://github.com/StaticJsCMS/static-cms/tree/main/packages/docs ) | [staticcms.org ](https://www.staticcms.org/ ) | [](https://app.netlify.com/sites/staticjscms/deploys) |
2023-01-27 10:27:13 -05:00
# Platform Templates
2023-01-27 10:57:25 -05:00
|Name|Demo|Status|
|---|---|---|
| [Next ](https://nextjs.org/ ) - [static-cms-next-netlify-template ](https://github.com/StaticJsCMS/static-cms-next-netlify-template ) | [next.staticcms.org ](https://next.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-next/deploys) |
| [Gastby ](https://www.gatsbyjs.com/ ) - [static-cms-gatsby-netlify-template ](https://github.com/StaticJsCMS/static-cms-gatsby-netlify-template ) | [gatsby.staticcms.org ](https://gatsby.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-gatsby/deploys) |
| [Hugo ](https://gohugo.io/ ) - [static-cms-hugo-netlify-template ](https://github.com/StaticJsCMS/static-cms-hugo-netlify-template ) | [hugo.staticcms.org ](https://hugo.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-hugo/deploys) |
| [Nuxt ](https://nuxtjs.org/ ) - [static-cms-nuxt-netlify-template ](https://github.com/StaticJsCMS/static-cms-nuxt-netlify-template ) | [nuxt.staticcms.org ](https://nuxt.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-nuxt/deploys) |
| [Preact ](https://preactjs.com/ ) - [static-cms-preact-netlify-template ](https://github.com/StaticJsCMS/static-cms-preact-netlify-template ) | [preact.staticcms.org ](https://preact.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-preact/deploys) |
| [Eleventy ](https://www.11ty.dev/ ) - [static-cms-eleventy-netlify-template ](https://github.com/StaticJsCMS/static-cms-eleventy-netlify-template ) | [eleventy.staticcms.org ](https://eleventy.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-eleventy/deploys) |
2023-01-27 10:27:13 -05:00
# Workflow Templates
2023-01-27 10:37:38 -05:00
2023-01-27 10:57:25 -05:00
|Name|Demo|Status|
|---|---|---|
2023-01-27 11:18:37 -05:00
| [Editorial Workflow Template ](https://github.com/StaticJsCMS/static-cms-next-netlify-editoral-template ) | Production: [next-editorial.staticcms.org ](https://next-editorial.staticcms.org/ )< br /> Staging: [next-editorial-staging.staticcms.org ](https://next-editorial-staging.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-next-editorial/deploys)< br /> [](https://app.netlify.com/sites/static-cms-next-editorial-staging/deploys) |
2023-01-27 10:37:38 -05:00
# Other Projects
|Name|Status|
|---|---|
2023-02-01 10:46:43 -05:00
| [static-cms-proxy-server ](https://github.com/StaticJsCMS/static-cms-proxy-server ) | [](https://github.com/StaticJsCMS/static-cms-proxy-server/actions/workflows/build-and-test.yml) [](https://www.npmjs.com/package/@staticcms/proxy-server) |
| [gatsby-plugin-static-cms ](https://github.com/StaticJsCMS/gatsby-plugin-static-cms ) | [](https://github.com/StaticJsCMS/gatsby-plugin-static-cms/actions/workflows/build.yml) [](https://www.npmjs.com/package/gatsby-plugin-static-cms) |
2023-01-27 10:27:13 -05:00
2018-10-24 18:45:57 -05:00
# Contributing
2022-10-02 20:06:20 -04:00
New contributors are always welcome! Check out [CONTRIBUTING.md ](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md ) to get involved.
2018-10-24 18:45:57 -05:00
2017-02-08 16:29:15 -02:00
# Change Log
2016-09-20 11:29:45 -03:00
2017-09-14 01:08:43 +02:00
This project adheres to [Semantic Versioning ](http://semver.org/ ).
2022-10-02 20:06:20 -04:00
Every release is documented on the Github [Releases ](https://github.com/StaticJsCMS/static-cms/releases ) page.
2016-09-20 11:29:45 -03:00
2017-02-08 16:29:15 -02:00
# License
2016-09-20 11:29:45 -03:00
2022-10-02 20:06:20 -04:00
Static CMS is released under the [MIT License ](LICENSE ).
2017-02-08 16:29:15 -02:00
Please make sure you understand its [implications and guarantees ](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html ).
2016-11-11 16:19:25 -08:00
2022-09-30 08:20:36 -04:00
# Netlify CMS
2022-10-25 09:18:18 -04:00
Static CMS is a fork of Netlify CMS focusing on the core product over adding massive, scope expanding, new features.
