91 lines
7.8 KiB
Markdown
91 lines
7.8 KiB
Markdown
<div align="center">
|
|
<img src="static-cms-logo.png" width="500px" />
|
|
|
|
[](https://github.com/StaticJsCMS/static-cms/blob/main/LICENSE)
|
|
[](https://github.com/StaticJsCMS/static-cms/actions/workflows/build.yml)
|
|
[](https://www.npmjs.com/package/@staticcms/core)
|
|
[](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md)
|
|
<div align="center">
|
|
|
|
[Docs](https://staticcms.org/)
|
|
| [Demo](https://demo.staticcms.org/)
|
|
| [Issues](https://github.com/StaticJsCMS/static-cms/issues)
|
|
| [Discord](https://discord.gg/ZWJM9pBMjj)
|
|
|
|
</div>
|
|
</div>
|
|
|
|
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](https://staticcms.org/docs/intro/).
|
|
|
|
# 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](https://staticcms.org/docs/add-to-your-site-cdn/)
|
|
- 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](https://staticcms.org/docs/add-to-your-site-bundling/)
|
|
|
|
# Projects
|
|
|
|
|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) |
|
|
|
|
# Platform Templates
|
|
|
|
|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) |
|
|
|
|
# Workflow Templates
|
|
|
|
|Name|Demo|Status|
|
|
|---|---|---|
|
|
| [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) |
|
|
|
|
# Other Projects
|
|
|
|
|Name|Status|
|
|
|---|---|
|
|
| [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) |
|
|
| [gatsby-plugin-static-cms](https://github.com/StaticJsCMS/gatsby-plugin-static-cms) | [](https://github.com/StaticJsCMS/gatsby-plugin-static-cms/actions/workflows/build.yml) |
|
|
|
|
# Contributing
|
|
|
|
New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md) to get involved.
|
|
|
|
# Change Log
|
|
|
|
This project adheres to [Semantic Versioning](http://semver.org/).
|
|
Every release is documented on the Github [Releases](https://github.com/StaticJsCMS/static-cms/releases) page.
|
|
|
|
# License
|
|
|
|
Static CMS is released under the [MIT License](LICENSE).
|
|
Please make sure you understand its [implications and guarantees](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html).
|
|
|
|
# Netlify CMS
|
|
|
|
Static CMS is a fork of Netlify CMS focusing on the core product over adding massive, scope expanding, new features.
|