Skip to content

docs: add local development quick start section and fix typo in README #7656

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add local development quick start section and fix typo in README #7656

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 40 additions & 45 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,70 +1,65 @@
![Decap CMS](/img/decap.svg)
# [Decap CMS](https://decapcms.org) 📝

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/decaporg/decap-cms/blob/main/LICENSE) [![Netlify Status](https://api.netlify.com/api/v1/badges/8b87160b-0a11-4f75-8050-1d21bc1cff8c/deploy-status)](https://app.netlify.com/sites/decap-www/deploys) [![npm version](https://img.shields.io/npm/v/decap-cms.svg?style=flat)](https://www.npmjs.com/package/decap-cms) [![Build Status](https://github.com/decaporg/decap-cms/workflows/Node%20CI/badge.svg)](https://github.com/decaporg/decap-cms/actions?query=branch%3Amain+workflow%3A%22Node+CI%22) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/decaporg/decap-cms/blob/main/CONTRIBUTING.md)
![Decap CMS Logo](/img/decap.svg)

[decapcms.org](https://www.decapcms.org/)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=for-the-badge)](https://github.com/sponsors/decaporg)
[![Open Collective](https://img.shields.io/badge/Sponsor-Open%20Collective-blue?style=for-the-badge)](https://opencollective.com/decap)

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.
---

_Decap CMS is the new name of Netlify CMS [since February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/)._
> **Decap CMS** is an open-source content management system (CMS) built for static site generators.
> It provides a simple, user-friendly way to manage and edit content stored in a Git repository — directly from your site’s `/admin` panel.

<a href="https://decapcms.org/chat">Join us on Discord</a> for community chat.
_Formerly known as **Netlify CMS**, Decap CMS was renamed in [February 2023](https://www.netlify.com/blog/netlify-cms-is-now-decap-cms/)._

## How It Works
Join our community chat on **[Discord](https://decapcms.org/chat)** 💬

Decap 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.
## 🚀 How It Works

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.
Decap CMS is a single-page React application that you place under the `/admin` path of your static 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.
It provides a clean UI for editing content stored in your Git repository.

Read more about Decap CMS [Core Concepts](https://www.decapcms.org/docs/intro/).
- You configure the CMS using a YAML file (`config.yml`) that defines your site’s content model.
- You can customize the layout and behavior to suit your project.
- When users visit `/admin/`, they log in and edit or create content directly through the CMS interface.
- All changes are committed to your repository.

## Installation and Configuration
📖 Learn more in the [Core Concepts documentation](https://decapcms.org/docs/intro/).

The Decap 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 [Quick Start Guide](https://www.decapcms.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.
## ⚙️ Installation and Configuration

## Sponsor
Decap CMS can be used in **two main ways**:

Help support Decap CMS development by becoming a sponsor! Your contributions help us maintain and improve this open-source project.
### 1. Quick Start (Recommended)
A fast setup method that only requires an HTML file and a simple configuration.

[![GitHub Sponsors](https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=for-the-badge&logo=github)](https://github.com/sponsors/decaporg)
[![Open Collective](https://img.shields.io/badge/Sponsor-Open%20Collective-blue?style=for-the-badge&logo=opencollective)](https://opencollective.com/decap)
👉 See the [Quick Start Guide](https://decapcms.org/docs/quick-start/).

These are our sponsors on both platforms. Thank you for your support!
### 2. Advanced Setup
For full flexibility, integrate Decap CMS into your build or deploy workflow.
This setup is ideal for large projects and supports custom widgets, backends, and authentication.

![Open Collective Backers](https://opencollective.com/decap/backers.svg?limit=30&button=false&avatarHeight=48&width=400)
👉 Learn more in the [Advanced Configuration Guide](https://decapcms.org/docs/add-to-your-site/).

<!-- sponsors --><a href="https://github.com/Zwyx"><img src="https://github.com/Zwyx.png" width="48px" alt="Zwyx" style="border-radius:50%" /></a> &nbsp;<a href="https://github.com/smolcodes"><img src="https://github.com/smolcodes.png" width="48px" alt="smolcodes" style="border-radius:50%" /></a> &nbsp;<a href="https://github.com/shizik"><img src="https://github.com/shizik.png" width="48px" alt="shizik" style="border-radius:50%" /></a> &nbsp;<a href="https://github.com/JacquesRaoult"><img src="https://github.com/JacquesRaoult.png" width="48px" alt="JacquesRaoult" style="border-radius:50%" /></a> &nbsp;<!-- sponsors -->
---

## Contribute
## 🧰 Local Development (Optional)

New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/decaporg/decap-cms/blob/main/CONTRIBUTING.md) to get involved.
If you want to contribute or test Decap CMS locally:

## Change Log
```bash
# Clone your fork
git clone https://github.com/<your-username>/decap-cms.git
cd decap-cms

This project adheres to [Semantic Versioning](http://semver.org/).
Every release is documented on the GitHub [Releases](https://github.com/decaporg/decap-cms/releases) page.
# Install dependencies
npm install

## License

Decap 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).

## Maintainers

Maintained with care by <a href="https://techhub.p-m.si/">PM TechHub</a> & friends.

## Professional help

Our partners offer a range of services that can help you get the most out of Decap CMS. Find onboarding, priority support, and development of custom features.

[Read more on our professional help page](https://decapcms.org/services/)
# Start the development environment
npm start