static-cms/README.md

69 lines
3.6 KiB
Markdown
Raw Normal View History

![Netlify CMS](cms.png)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/netlify/netlify-cms/blob/master/LICENSE) [![Netlify Status](https://api.netlify.com/api/v1/badges/2cfc19a8-1216-4070-bbb4-4a1c38b57132/deploy-status)](https://app.netlify.com/sites/cms-demo/deploys) [![npm version](https://img.shields.io/npm/v/netlify-cms.svg?style=flat)](https://www.npmjs.com/package/netlify-cms) [![Build Status](https://github.com/netlify/netlify-cms/workflows/Node%20CI/badge.svg)](https://github.com/netlify/netlify-cms/actions?query=branch%3Amaster+workflow%3A%22Node+CI%22) ![FOSSA Status](https://app.fossa.com/api/projects/custom%2B17679%2Fgit%40github.com%3Anetlify%2Fnetlify-cms.git.svg?type=shield) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md)
[netlifycms.org](https://www.netlifycms.org/)
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.
## Community Chat
<a href="https://netlifycms.org/chat">
<img alt="Join us on Slack" src="https://raw.githubusercontent.com/netlify/netlify-cms/master/website/static/img/slack.png" width="165"/>
</a>
## How It Works
2016-06-05 12:48:28 -07: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.
When a user navigates to `/admin/` they'll be prompted to log in, and once authenticated
2017-03-17 16:12:25 +00:00
they'll be able to create new content or edit existing content.
2016-09-20 11:29:45 -03: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
2019-10-24 03:58:41 +10:00
* 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 [Quick Start Guide](https://www.netlifycms.org/docs/quick-start/)
* 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
# Contributing
New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md) to get involved.
2017-02-08 16:29:15 -02:00
# Change Log
2016-09-20 11:29:45 -03: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
2018-04-11 17:47:23 -04:00
# Thanks
2016-11-11 16:19:25 -08:00
2018-04-11 17:47:23 -04:00
## Services
These services support Netlify CMS development by providing free infrastructure.
2018-04-11 17:54:25 -04:00
<p>
2018-04-11 17:47:23 -04:00
<a href="https://www.travis-ci.org">
<img src="https://raw.githubusercontent.com/netlify/netlify-cms/master/img/travis.png" height="38" alt="travis-ci" />
2018-04-11 17:47:23 -04:00
</a>
2018-04-11 17:54:25 -04:00
<img src="https://spacergif.org/spacer.gif" width="20"/>
2018-04-11 17:47:23 -04:00
<a href="https://www.browserstack.com">
<img src="https://raw.githubusercontent.com/netlify/netlify-cms/master/img/browserstack.png" height="38" alt="browserstack" />
2018-04-11 17:47:23 -04:00
</a>
2019-06-03 19:26:44 -04:00
<img src="https://spacergif.org/spacer.gif" width="20"/>
<a href="https://www.cypress.io">
<img src="https://raw.githubusercontent.com/netlify/netlify-cms/master/img/cypressio.png" height="38" alt="Cypress.io" />
</a>
2018-04-11 17:47:23 -04:00
</p>