static-cms/README.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

2016-06-05 12:48:28 -07:00
# Netlify CMS
A CMS for static site generators. Give non-technical users a simple way to edit
and add content to any site built with a static site generator.
## How it works
Netlify 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` she'll be prompted to login, and once authenticated
she'll be able to create new content or edit existing content.
2016-09-20 11:29:45 -03:00
2017-02-08 16:29:15 -02:00
Read more about Netlify CMS [Core Concepts](docs/intro.md).
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
2017-02-08 16:29:15 -02:00
The Netlify CMS can be used in two different ways.
2016-09-20 11:29:45 -03:00
2017-02-08 16:29:15 -02:00
* A Quick and easy install, that just 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 [Quick Start Guide](docs/quick-start.md)
* A complete, more complex install, that gives you more flexibility but requires that you use a static site builder with a build system with supports npm packages.
2017-01-22 13:09:20 +00:00
2017-02-08 16:29:15 -02:00
# Change Log
2016-09-20 11:29:45 -03:00
2017-02-08 16:29:15 -02:00
This project adheres to [Semantic Versioning](http://semver.org/).
Every release is documented on the Github [Releases](https://github.com/netlify/netlify-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
2017-02-08 16:29:15 -02:00
Netlify 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).
2016-11-11 16:19:25 -08:00