62 lines
3.1 KiB
Markdown
62 lines
3.1 KiB
Markdown
<div align="center">
|
|
<img src="static-cms-logo.png" width="500px" />
|
|
|
|
[](https://github.com/StaticJsCMS/static-cms/blob/main/LICENSE)
|
|
[](https://www.npmjs.com/package/@staticcms/core)
|
|
[](https://www.npmjs.com/package/@staticcms/core/v/next)
|
|
[](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md)
|
|
|
|
</div>
|
|
|
|
[staticjscms.netlify.app](https://staticjscms.netlify.app/)
|
|
|
|
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.
|
|
|
|
> **DISCLAIMER**: This package/repository is under heavy development and as such is very unstable at current. A stable release is targeted for around the end of the year and will be labeled `1.0.0`. Documentation may not be completely accurate prior to the `1.0.0` release.
|
|
>
|
|
> An beta build for the stable release is available under the `@next` tack on npm.
|
|
|
|
## 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://staticjscms.netlify.app/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://staticjscms.netlify.app/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://staticjscms.netlify.app/docs/add-to-your-site-bundling/)
|
|
|
|
# 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.
|
|
|
|
# Thanks
|