120 lines
13 KiB
Markdown
120 lines
13 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)
|
|
[](#contributors)
|
|
<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|Beta|
|
|
|---|---|---|---|
|
|
| [@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) | [](https://www.npmjs.com/package/@staticcms/core/v/next) |
|
|
| [@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) | [](https://www.npmjs.com/package/@staticcms/app/v/next) |
|
|
| [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) | [Beta Demo](https://next.demo.staticcms.org/) |
|
|
| [docs](https://github.com/StaticJsCMS/static-cms/tree/main/packages/docs) | [staticcms.org](https://www.staticcms.org/) | [](https://app.netlify.com/sites/staticjscms/deploys) | [Beta Docs](https://next.staticcms.org/) |
|
|
|
|
# Platform Templates
|
|
|
|
|Name|Demo|Status|
|
|
|---|---|---|
|
|
| [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) |
|
|
| [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) |
|
|
| [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) |
|
|
|
|
# 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) [](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) |
|
|
|
|
# Contributing
|
|
|
|
New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md) to get involved.
|
|
|
|
## Contributors
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<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>
|
|
<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>
|
|
<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>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
# 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).
|
|
|
|
# Decap
|
|
|
|
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.
|
|
|
|
## Support
|
|
|
|
For help with integrating Static CMS with your site, check out the community [Discord](https://discord.com/invite/ZWJM9pBMjj).
|