2016-06-05 12:48:28 -07:00
# Netlify CMS
2017-12-01 14:55:04 -05:00
[![All Contributors ](https://img.shields.io/badge/all_contributors-53-orange.svg )](#contributors)
2017-12-01 14:53:56 -05:00
[![ ](https://badges.gitter.im/Join%20Chat.svg )](https://gitter.im/netlify/netlifycms)
2016-06-05 12:48:28 -07: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.
## 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.
2017-03-17 16:12:25 +00:00
When a user navigates to `/admin` they'll be prompted to login, and once authenticated
they'll be able to create new content or edit existing content.
2016-09-20 11:29:45 -03:00
2017-12-05 09:05:42 -07:00
Read more about Netlify CMS [Core Concepts ](https://www.netlifycms.org/docs/intro/ ).
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.
2017-12-05 09:05:42 -07:00
To learn more about this installation method, refer to the [Quick Start Guide ](https://www.netlifycms.org/docs/quick-start/ )
2017-03-22 08:51:21 -04: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.
2017-01-22 13:09:20 +00:00
2017-03-20 10:56:46 -07:00
# Community
2017-12-01 14:50:29 -05:00
Netlify CMS has a [Gittercommunity ](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.
2017-03-20 10:56:46 -07:00
2017-02-08 16:29:15 -02:00
# Change Log
2016-09-20 11:29:45 -03:00
2017-09-14 01:08:43 +02:00
This project adheres to [Semantic Versioning ](http://semver.org/ ).
2017-02-08 16:29:15 -02:00
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
2017-09-14 01:08:43 +02:00
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
2017-11-17 00:06:23 +03:00
| [<img src="https://avatars2.githubusercontent.com/u/33676?v=4" width="100px;"/><br /><sub>Cássio Souza</sub> ](https://twitter.com/cassiozen )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=cassiozen "Code") | [<img src="https://avatars3.githubusercontent.com/u/2112202?v=4" width="100px;"/><br /><sub>Shawn Erquhart</sub> ](https://erquh.art )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=erquhart "Code") | [<img src="https://avatars3.githubusercontent.com/u/11071?v=4" width="100px;"/><br /><sub>Andrey Okonetchnikov</sub> ](http://okonet.ru )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=okonet "Code") | [<img src="https://avatars0.githubusercontent.com/u/6515?v=4" width="100px;"/><br /><sub>Mathias Biilmann</sub> ](https://www.netlify.com )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=biilmann "Code") | [<img src="https://avatars1.githubusercontent.com/u/1425133?v=4" width="100px;"/><br /><sub>Benaiah Mischenko</sub> ](http://benaiah.me )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=Benaiah "Code") | [<img src="https://avatars0.githubusercontent.com/u/2281080?v=4" width="100px;"/><br /><sub>Rafael Conde</sub> ](http://rafaelconde.net )< br /> [🎨](#design-rafaelconde "Design") | [<img src="https://avatars0.githubusercontent.com/u/2513147?v=4" width="100px;"/><br /><sub>Joseph Earl</sub> ](http://josephearl.co.uk )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=josephearl "Code") |
2017-09-14 01:08:43 +02:00
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
2017-11-17 00:06:23 +03:00
| [<img src="https://avatars2.githubusercontent.com/u/5713670?v=4" width="100px;"/><br /><sub>Brian Douglas</sub> ](https://briandouglas.me/ )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=bdougie "Code") | [<img src="https://avatars3.githubusercontent.com/u/44568?v=4" width="100px;"/><br /><sub>Frances Berriman</sub> ](https://fberriman.com )< br /> [🎨](#design-phae "Design") | [<img src="https://avatars0.githubusercontent.com/u/1050?v=4" width="100px;"/><br /><sub>David Calavera</sub> ](https://github.com/calavera )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=calavera "Code") | [<img src="https://avatars0.githubusercontent.com/u/8883545?v=4" width="100px;"/><br /><sub>Luis Correia</sub> ](https://luisc.pt )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=lmcorreia "Code") | [<img src="https://avatars1.githubusercontent.com/u/20345941?v=4" width="100px;"/><br /><sub>Caleb</sub> ](https://github.com/tech4him1 )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=tech4him1 "Code") | [<img src="https://avatars0.githubusercontent.com/u/3292160?v=4" width="100px;"/><br /><sub>Jerry Holmes</sub> ](http://www.pagedragon.com )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=jholmes033169 "Code") | [<img src="https://avatars0.githubusercontent.com/u/8377185?v=4" width="100px;"/><br /><sub>abumalick</sub> ](https://github.com/abumalick )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=abumalick "Code") |
| [<img src="https://avatars1.githubusercontent.com/u/4513526?v=4" width="100px;"/><br /><sub>Eamonn Bell</sub> ](http://www.eamonnbell.com )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=eamonnbell "Code") | [<img src="https://avatars2.githubusercontent.com/u/6111186?v=4" width="100px;"/><br /><sub>Jessica Parsons</sub> ](https://github.com/verythorough )< br /> [📖](https://github.com/netlify/netlify-cms/commits?author=verythorough "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/71047?v=4" width="100px;"/><br /><sub>Kyle Mathews</sub> ](https://www.bricolage.io )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=KyleAMathews "Code") | [<img src="https://avatars1.githubusercontent.com/u/16258690?v=4" width="100px;"/><br /><sub>americool</sub> ](https://github.com/americool )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=americool "Code") | [<img src="https://avatars3.githubusercontent.com/u/3051737?v=4" width="100px;"/><br /><sub>Damien Duhamel</sub> ](http://www.damienduhamel.fr )< br /> | [<img src="https://avatars1.githubusercontent.com/u/1188186?v=4" width="100px;"/><br /><sub>Julian Krispel-Samsel</sub> ](http://reactrocket.com )< br /> | [<img src="https://avatars0.githubusercontent.com/u/6445815?v=4" width="100px;"/><br /><sub>Kevin McCormack</sub> ](http://harlemsquirrel.github.io/ )< br /> |
| [<img src="https://avatars3.githubusercontent.com/u/1923476?v=4" width="100px;"/><br /><sub>Kalin Chernev</sub> ](https://github.com/kalinchernev )< br /> | [<img src="https://avatars2.githubusercontent.com/u/5018268?v=4" width="100px;"/><br /><sub>tortilaman</sub> ](https://github.com/tortilaman )< br /> | [<img src="https://avatars0.githubusercontent.com/u/1184334?v=4" width="100px;"/><br /><sub>Václav Klecanda</sub> ](http://www.vxk.cz )< br /> | [<img src="https://avatars0.githubusercontent.com/u/2983665?v=4" width="100px;"/><br /><sub>DrianHillman</sub> ](http://drianhillman.me )< br /> | [<img src="https://avatars1.githubusercontent.com/u/1198032?v=4" width="100px;"/><br /><sub>Sean Crawford</sub> ](https://github.com/seantcoyote )< br /> | [<img src="https://avatars1.githubusercontent.com/u/111932?v=4" width="100px;"/><br /><sub>Robert Riemann</sub> ](http://blog.riemann.cc )< br /> | [<img src="https://avatars1.githubusercontent.com/u/4165105?v=4" width="100px;"/><br /><sub>Ben Berman</sub> ](http://jygabyte.com )< br /> |
| [<img src="https://avatars3.githubusercontent.com/u/4349324?v=4" width="100px;"/><br /><sub>Benjamin Kniffler</sub> ](https://github.com/bkniffler )< br /> | [<img src="https://avatars1.githubusercontent.com/u/845983?v=4" width="100px;"/><br /><sub>Mike Wickett</sub> ](http://www.wickett.ca )< br /> | [<img src="https://avatars1.githubusercontent.com/u/2751799?v=4" width="100px;"/><br /><sub>Rory Claasen</sub> ](http://roryclaasen.me )< br /> | [<img src="https://avatars3.githubusercontent.com/u/724844?v=4" width="100px;"/><br /><sub>Frederic Brodbeck</sub> ](http://www.freder.io/ )< br /> | [<img src="https://avatars2.githubusercontent.com/u/1245746?v=4" width="100px;"/><br /><sub>Stuart Dum</sub> ](https://github.com/simplystuart )< br /> | [<img src="https://avatars0.githubusercontent.com/u/8184251?v=4" width="100px;"/><br /><sub>Ryan Watters</sub> ](https://github.com/rdwatters )< br /> | [<img src="https://avatars3.githubusercontent.com/u/4315?v=4" width="100px;"/><br /><sub>Helder S Ribeiro</sub> ](https://twitter.com/hsribei )< br /> |
| [<img src="https://avatars1.githubusercontent.com/u/979966?v=4" width="100px;"/><br /><sub>Artem Govorov</sub> ](http://dm.gl )< br /> | [<img src="https://avatars3.githubusercontent.com/u/2683300?v=4" width="100px;"/><br /><sub>Cédric Delpoux</sub> ](http://xuopled.netlify.com/ )< br /> | [<img src="https://avatars3.githubusercontent.com/u/83225?v=4" width="100px;"/><br /><sub>imorente</sub> ](https://github.com/imorente )< br /> | [<img src="https://avatars3.githubusercontent.com/u/5230460?v=4" width="100px;"/><br /><sub>David Francoeur</sub> ](http://davidfrancoeur.com )< br /> | [<img src="https://avatars3.githubusercontent.com/u/1954977?v=4" width="100px;"/><br /><sub>Rusta</sub> ](https://github.com/Rusta )< br /> | [<img src="https://avatars1.githubusercontent.com/u/1299786?v=4" width="100px;"/><br /><sub>Henrik Lau Eriksson</sub> ](http://henrik.laueriksson.com )< br /> | [<img src="https://avatars0.githubusercontent.com/u/1294877?v=4" width="100px;"/><br /><sub>Kraig Walker</sub> ](https://www.kraigwalker.com )< br /> |
| [<img src="https://avatars1.githubusercontent.com/u/2994311?v=4" width="100px;"/><br /><sub>Rich Cook</sub> ](http://www.TalesofMurder.com )< br /> | [<img src="https://avatars3.githubusercontent.com/u/1309950?v=4" width="100px;"/><br /><sub>Damien Van Der Windt</sub> ](https://github.com/damienvdw )< br /> | [<img src="https://avatars2.githubusercontent.com/u/1571899?v=4" width="100px;"/><br /><sub>Matt Jared</sub> ](http://mattjared.github.io/ )< br /> | [<img src="https://avatars1.githubusercontent.com/u/1100280?v=4" width="100px;"/><br /><sub>bruce-one</sub> ](https://github.com/bruce-one )< br /> | [<img src="https://avatars3.githubusercontent.com/u/103008?v=4" width="100px;"/><br /><sub>Frank Taillandier</sub> ](https://frank.taillandier.me )< br /> [📖](https://github.com/netlify/netlify-cms/commits?author=DirtyF "Documentation") | [<img src="https://avatars0.githubusercontent.com/u/2936813?v=4" width="100px;"/><br /><sub>Aquib Master</sub> ](http://aquibm.com/ )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=aquibm "Code") | [<img src="https://avatars0.githubusercontent.com/u/3147296?v=4" width="100px;"/><br /><sub>Eric Jinks</sub> ](http://ericjinks.com )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=Jinksi "Code") |
| [<img src="https://avatars3.githubusercontent.com/u/784848?v=4" width="100px;"/><br /><sub>Tony Alves</sub> ](https://github.com/talves )< br /> [💻](https://github.com/netlify/netlify-cms/commits?author=talves "Code") | [<img src="https://avatars3.githubusercontent.com/u/782?v=4" width="100px;"/><br /><sub>Ernie Bello</sub> ](http://ern.me )< br /> [🐛](https://github.com/netlify/netlify-cms/issues?q=author%3Aebello "Bug reports") | [<img src="https://avatars3.githubusercontent.com/u/6202476?v=4" width="100px;"/><br /><sub>Alexander Kushi-Willis</sub> ](https://ackushiw.com )< br /> [📖](https://github.com/netlify/netlify-cms/commits?author=ackushiw "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/54089?v=4" width="100px;"/><br /><sub>Igor Kuznetsov</sub> ](http://www.igk.ru )< br /> [🐛](https://github.com/netlify/netlify-cms/issues?q=author%3Aigk1972 "Bug reports") [💻 ](https://github.com/netlify/netlify-cms/commits?author=igk1972 "Code" ) [🔌 ](#plugin-igk1972 "Plugin/utility libraries" ) |
2017-09-14 01:08:43 +02:00
<!-- ALL - CONTRIBUTORS - LIST:END -->
This project follows the [all-contributors ](https://github.com/kentcdodds/all-contributors ) specification. Contributions of any kind welcome!