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-02-07 14:48:56 -05:00
[](#contributors )
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|
|---|---|---|
2023-04-06 09:55:29 -04:00
| [Next ](https://nextjs.org/ ) - [static-cms-next-netlify-template ](https://github.com/StaticJsCMS/static-cms-next-netlify-template ) | [next-template.staticcms.org ](https://next-template.staticcms.org/ ) | [](https://app.netlify.com/sites/static-cms-next/deploys) |
2023-02-27 23:35:55 +01:00
| [Gatsby ](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) |
2023-01-27 10:57:25 -05:00
| [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
2023-02-07 09:26:33 -05:00
# Sponsors
< table >
< tbody >
< tr >
< td align = "center" > < a href = "https://github.com/slickduck" > < img alt = "slickduck" src = "https://avatars.githubusercontent.com/u/124680931?s=100&v=4" width = "100" height = "100" / > < br / > < sub > < b > Slick Duck< / b > < / sub > < / a > < / td >
< / t >
< / tbody >
< / table >
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
2023-02-07 09:29:05 -05:00
## Contributors
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
<!-- prettier - ignore - start -->
<!-- markdownlint - disable -->
2023-02-07 14:48:56 -05:00
< table >
< tbody >
< tr >
< td align = "center" valign = "top" width = "14.28%" >< a href = "https://github.com/KaneFreeman" >< img src = "https://avatars.githubusercontent.com/u/1388138?v=4?s=100" width = "100px;" alt = "Daniel Lautzenheiser" />< br />< sub >< b > Daniel Lautzenheiser</ b ></ sub ></ a >< br />< a href = "https://github.com/StaticJsCMS/static-cms/commits?author=KaneFreeman" title = "Code" > 💻</ a > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=KaneFreeman" title = "Documentation" > 📖</ a > < a href = " #design -KaneFreeman" title = "Design" > 🎨</ a > < a href = " #maintenance -KaneFreeman" title = "Maintenance" > 🚧</ a ></ td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/denyskon" > < img src = "https://avatars.githubusercontent.com/u/47871822?v=4?s=100" width = "100px;" alt = "Denys Konovalov" / > < br / > < sub > < b > Denys Konovalov< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=denyskon" title = "Code" > 💻< / a > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=denyskon" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://commanderstorm.github.io/" > < img src = "https://avatars.githubusercontent.com/u/26258709?v=4?s=100" width = "100px;" alt = "Frank Elsinga" / > < br / > < sub > < b > Frank Elsinga< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=CommanderStorm" title = "Code" > 💻< / a > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=CommanderStorm" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/Skrubbadubba" > < img src = "https://avatars.githubusercontent.com/u/75796723?v=4?s=100" width = "100px;" alt = "Skrubbadubba" / > < br / > < sub > < b > Skrubbadubba< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=Skrubbadubba" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/a-kriya" > < img src = "https://avatars.githubusercontent.com/u/26761352?v=4?s=100" width = "100px;" alt = "a-kriya" / > < br / > < sub > < b > a-kriya< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=a-kriya" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/whysthatso" > < img src = "https://avatars.githubusercontent.com/u/1685114?v=4?s=100" width = "100px;" alt = "Andreas Wagner" / > < br / > < sub > < b > Andreas Wagner< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=whysthatso" title = "Documentation" > 📖< / a > < / td >
2023-02-07 15:41:49 -05:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/McFlyPartages" > < img src = "https://avatars.githubusercontent.com/u/44530252?v=4?s=100" width = "100px;" alt = "McFlyPartages" / > < br / > < sub > < b > McFlyPartages< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=McFlyPartages" title = "Documentation" > 📖< / a > < / td >
< / tr >
< tr >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/robigan" > < img src = "https://avatars.githubusercontent.com/u/35210888?v=4?s=100" width = "100px;" alt = "robigan" / > < br / > < sub > < b > robigan< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=robigan" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "http://mildred.fr/" > < img src = "https://avatars.githubusercontent.com/u/33804?v=4?s=100" width = "100px;" alt = "Mildred Ki'Lya" / > < br / > < sub > < b > Mildred Ki'Lya< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=mildred" title = "Code" > 💻< / a > < / td >
2023-03-02 10:32:08 -05:00
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://github.com/acharlop" > < img src = "https://avatars.githubusercontent.com/u/8885448?v=4?s=100" width = "100px;" alt = "Avi Charlop" / > < br / > < sub > < b > Avi Charlop< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=acharlop" title = "Documentation" > 📖< / a > < / td >
< td align = "center" valign = "top" width = "14.28%" > < a href = "https://dominiclooser.ch/" > < img src = "https://avatars.githubusercontent.com/u/2300581?v=4?s=100" width = "100px;" alt = "dominiclooser" / > < br / > < sub > < b > dominiclooser< / b > < / sub > < / a > < br / > < a href = "https://github.com/StaticJsCMS/static-cms/commits?author=dominiclooser" title = "Documentation" > 📖< / a > < / td >
2023-02-07 14:48:56 -05:00
< / tr >
< / tbody >
< / table >
2023-02-07 09:29:05 -05:00
<!-- markdownlint - restore -->
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
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
2023-04-20 14:28:33 -04:00
# Decap
2022-09-30 08:20:36 -04:00
2023-04-20 14:28:33 -04:00
Static CMS is a fork of [Decap ](https://github.com/decaporg/decap-cms ) (previously Netlify CMS) focusing on the core product over adding massive, scope expanding, new features.
