Skip to content

Commit 6e95190

Browse files
2400032703kotinijeswanth2400032703kotinijeswanth
committed
docs: add local development quick start section and fix typo in README
1 parent 826a300 commit 6e95190

File tree

1 file changed

+40
-45
lines changed

1 file changed

+40
-45
lines changed

‎README.md‎

Lines changed: 40 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,65 @@
1-
![Decap CMS](/img/decap.svg)
1+
# [Decap CMS](https://decapcms.org) 📝
22

3-
[![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)
3+
![Decap CMS Logo](/img/decap.svg)
44

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

7-
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.
9+
---
810

9-
_Decap CMS is the new name of Netlify CMS [since February 2023](https://www.netlify.com/blog/netlify-cms-to-become-decap-cms/)._
11+
> **Decap CMS** is an open-source content management system (CMS) built for static site generators.
12+
> It provides a simple, user-friendly way to manage and edit content stored in a Git repository — directly from your site’s `/admin` panel.
1013
11-
<a href="https://decapcms.org/chat">Join us on Discord</a> for community chat.
14+
_Formerly known as **Netlify CMS**, Decap CMS was renamed in [February 2023](https://www.netlify.com/blog/netlify-cms-is-now-decap-cms/)._
1215

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

15-
Decap CMS is a single-page app that you pull into the `/admin` part of your site.
18+
---
1619

17-
It presents a clean UI for editing content stored in a Git repository.
20+
## 🚀 How It Works
1821

19-
You setup a YAML config to describe the content model of your site, and typically
20-
tweak the main layout of the CMS a bit to fit your own site.
22+
Decap CMS is a single-page React application that you place under the `/admin` path of your static site.
2123

22-
When a user navigates to `/admin/` they'll be prompted to log in, and once authenticated
23-
they'll be able to create new content or edit existing content.
24+
It provides a clean UI for editing content stored in your Git repository.
2425

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

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

29-
The Decap CMS can be used in two different ways.
33+
---
3034

31-
* 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.
32-
To learn more about this installation method, refer to the [Quick Start Guide](https://www.decapcms.org/docs/quick-start/)
33-
* 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.
35+
## ⚙️ Installation and Configuration
3436

35-
## Sponsor
37+
Decap CMS can be used in **two main ways**:
3638

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

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

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

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

46-
<!-- 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 -->
50+
---
4751

48-
## Contribute
52+
## 🧰 Local Development (Optional)
4953

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

52-
## Change Log
56+
```bash
57+
# Clone your fork
58+
git clone https://github.com/<your-username>/decap-cms.git
59+
cd decap-cms
5360

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

57-
## License
58-
59-
Decap CMS is released under the [MIT License](LICENSE).
60-
Please make sure you understand its [implications and guarantees](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html).
61-
62-
## Maintainers
63-
64-
Maintained with care by <a href="https://techhub.p-m.si/">PM TechHub</a> & friends.
65-
66-
## Professional help
67-
68-
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.
69-
70-
[Read more on our professional help page](https://decapcms.org/services/)
64+
# Start the development environment
65+
npm start

0 commit comments

Comments
 (0)