decap-cms README

The project's README from github.com/decaporg/decap-cms. As one markdown file: README.md.

Decap CMS

Documentation: decapcms.org

GitHub license Netlify Status npm version Build Status PRs Welcome

A CMS for static site generators. Give teams 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.

Join us on Discord for community chat.

How It Works

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.

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 they'll be able to create new content or edit existing content.

Read more about Decap CMS Core Concepts.

Installation and Configuration

Decap CMS can be used in two different ways.

Need centralized user management, advanced roles, a database proxy, or premium support? Explore Decap Turbo.

Sponsors

Help support Decap CMS development by becoming a sponsor! Your contributions help us maintain and improve this open-source project.

GitHub Sponsors Open Collective

Main Partner

Decap CMS is supported by our main partner PM.

Backers

Open Collective Backers

Zwyx  smolcodes  shizik  JacquesRaoult  

Thank you for your support!

Contribute

New contributors are always welcome! Check out CONTRIBUTING.md to get involved.

Change Log

This project adheres to Semantic Versioning. Every release is documented on the GitHub Releases page.

License

Decap CMS is released under the MIT License. Please make sure you understand its implications and guarantees.

Expert Services

Get hands-on help from Decap experts and partners for onboarding, custom feature development, website development and premium support.

Explore expert services

decap-cms (decaporg/decap-cms)

static-site
Searching Database…

19.4K ·GitHub
What is this?A Git-based CMS for static site generators: a single-page app you pull into the /admin part of your site, giving editors a clean UI for content stored in your Git repository.
Is this a service I sign up for, or does it run inside my own site?It runs inside your own site - nothing to sign up for. The CMS is a browser app served from your /admin folder, and content changes go straight into your Git repository.
How do I add it to my site?Two ways: a quick install that needs just a single HTML file and a config file (all CMS JS and CSS load from a CDN), or an advanced npm-based install through a static site builder for more flexibility.
How do I tell it what my content looks like?You write a YAML config file describing your site's content model. The advanced install additionally needs a static site builder with a build system that supports npm packages.
Is it good to go right after installing, or should I expect some tuning?Expect a bit of tuning: besides the config, you typically tweak the main layout of the CMS a little so it fits your own site.
Can non-technical editors use it, or is it a developer-only tool?Setup is developer work, but daily editing is not: editors navigate to /admin/, log in when prompted, and then create new content or edit existing content through the UI.
Is it really free and open source, or is there a paid tier?Fully free and open source under the MIT License. A separate product, Decap Turbo, covers centralized user management, advanced roles, a database proxy and premium support.
Is Decap CMS related to Netlify CMS?Yes - the repo still carries the netlify-cms topic: Decap CMS is the community continuation of that project, now developed independently under the decaporg organization.
Does it work with Hugo, Jekyll, Astro and other generators, or just one?It is generator-agnostic: Decap edits content stored in your Git repository, so it works with static site generators in general rather than being tied to one.
How mature is the project?It has been around since January 2015 with roughly 19,400 stars, and releases follow semantic versioning with every release documented on the GitHub Releases page.
What are similar projects?react-static, payload, strapi, tinacms, zola, gatsby, hugo, buildawesome
Creator
decaporg
Size
107.6 MB
Stars
19.4K
Age
11y
Commits · 90 Days