2018-07-26 18:05:29 -04:00
# Netlify CMS
[![ ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/netlify/netlifycms)
2018-07-26 18:01:26 -04:00
2018-07-26 18:05:29 -04:00
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.
2018-07-26 18:01:26 -04:00
2018-07-26 18:05:29 -04:00
## How it works
2018-07-26 18:01:26 -04:00
2018-07-26 18:05:29 -04:00
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.
2018-11-14 11:28:28 -05:00
When a user navigates to `/admin/` they'll be prompted to login, and once authenticated
2018-07-26 18:05:29 -04:00
they'll be able to create new content or edit existing content.
Read more about Netlify CMS [Core Concepts ](https://www.netlifycms.org/docs/intro/ ).
# Installation and Configuration
The Netlify CMS can be used in two different ways.
2018-08-14 11:33:13 -06: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.
2018-08-07 14:46:54 -06:00
To learn more about this installation method, refer to the [Quick Start Guide ](https://www.netlifycms.org/docs/quick-start/ )
2018-08-14 11:33:13 -06: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.
2018-07-26 18:05:29 -04:00
# Community
Netlify CMS has a [Gitter community ](https://gitter.im/netlify/netlifycms ) where members of the community hang out and share things about the project, as well as give and receive support.
2018-11-14 11:28:28 -05:00
# Contributing
New contributors are always welcome! Check out [CONTRIBUTING.md ](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md ) to get involved.
2018-07-26 18:05:29 -04:00
# Change Log
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.
# License
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 ).
# Thanks
## Services
These services support Netlify CMS development by providing free infrastructure.
< p >
< a href = "https://www.travis-ci.org" >
< img src = "https://raw.githubusercontent.com/netlify/netlify-cms/master/img/travis.png" height = "38" / >
< / a >
< img src = "https://spacergif.org/spacer.gif" width = "20" / >
< a href = "https://www.browserstack.com" >
< img src = "https://raw.githubusercontent.com/netlify/netlify-cms/master/img/browserstack.png" height = "38" / >
< / a >
< / p >