Skip to content
This repository was archived by the owner on Sep 9, 2024. It is now read-only.

Commit 3cfe6e1

Browse files
authored
Create README.md
0 parents  commit 3cfe6e1

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

profile/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<div align="center">
2+
<img src="static-cms-logo.png" width="500px" />
3+
4+
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/StaticJsCMS/static-cms/blob/main/LICENSE)
5+
[![Build](https://github.com/StaticJsCMS/static-cms/actions/workflows/build.yml/badge.svg)](https://github.com/StaticJsCMS/static-cms/actions/workflows/build.yml)
6+
[![npm latest package](https://img.shields.io/npm/v/@staticcms/core/latest.svg)](https://www.npmjs.com/package/@staticcms/core)
7+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md)
8+
9+
</div>
10+
11+
[staticjscms.netlify.app](https://staticjscms.netlify.app/)
12+
13+
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.
14+
15+
## How It Works
16+
17+
Static CMS is a single-page app that you pull into the `/admin` part of your site.
18+
19+
It presents a clean UI for editing content stored in a Git repository.
20+
21+
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.
22+
23+
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.
24+
25+
Read more about Static CMS [Core Concepts](https://staticjscms.netlify.app/docs/intro/).
26+
27+
# Installation and Configuration
28+
29+
The Static CMS can be used in two different ways.
30+
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 [CDN Hosting Guide](https://staticjscms.netlify.app/docs/add-to-your-site-cdn/)
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.
34+
To learn more about this installation method, refer to the [Bundling Guide](https://staticjscms.netlify.app/docs/add-to-your-site-bundling/)
35+
36+
# Contributing
37+
38+
New contributors are always welcome! Check out [CONTRIBUTING.md](https://github.com/StaticJsCMS/static-cms/blob/main/CONTRIBUTING.md) to get involved.
39+
40+
# Change Log
41+
42+
This project adheres to [Semantic Versioning](http://semver.org/).
43+
Every release is documented on the Github [Releases](https://github.com/StaticJsCMS/static-cms/releases) page.
44+
45+
# License
46+
47+
Static CMS is released under the [MIT License](LICENSE).
48+
Please make sure you understand its [implications and guarantees](https://writing.kemitchell.com/2016/09/21/MIT-License-Line-by-Line.html).
49+
50+
# Netlify CMS
51+
52+
Static CMS is a fork of Netlify CMS focusing on the core product over adding massive, scope expanding, new features.

0 commit comments

Comments
 (0)