Skip to content

Commit 22017b4

Browse files
verythoroughverythorough
authored
Update intro to direct to new content (#891)
1 parent bc0001b commit 22017b4

File tree

1 file changed

+6
-87
lines changed

1 file changed

+6
-87
lines changed

‎website/site/content/docs/intro.md

+6-87
Original file line numberDiff line numberDiff line change
@@ -16,92 +16,11 @@ At its core, Netlify CMS is an open-source React app that acts as a wrapper for
1616
* **Flexible content types:** specify an unlimited number of content types with custom fields.
1717
* **Fully extensible:** create custom-styled previews, UI widgets, and editor plugins.
1818

19-
# Core Concepts
2019

21-
## The Admin Interface
20+
## Find out more
2221

23-
The admin interface is a single-page app with the entry point stored in a static `/admin` folder you add to the root of your site. You can include it with a simple `index.html` file that loads the necessary CSS and JS files from a CDN:
24-
25-
``` html
26-
<!doctype html>
27-
<html>
28-
<head>
29-
<meta charset="utf-8" />
30-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
31-
<title>Content Manager</title>
32-
33-
<link rel="stylesheet" href="https://unpkg.com/netlify-cms@^0.7.0/dist/cms.css" />
34-
35-
</head>
36-
<body>
37-
<script src="https://unpkg.com/netlify-cms@^0.7.0/dist/cms.js"></script>
38-
</body>
39-
</html>
40-
```
41-
42-
The JS is also available via npm and can be integrated into your regular build process.
43-
44-
### Editorial Workflow
45-
46-
Netlify CMS has an optional [editorial workflow](/docs/editorial-workflow) that translates common Git commands into familiar language in a simple UI:
47-
48-
Actions in Netlify UI ... | Perform these Git actions
49-
--- | ---
50-
Save draft | Commits to a new branch, and opens a pull request
51-
Edit draft | Pushes another commit to the draft branch/pull request
52-
Approve and publish draft | Merges pull request and deletes branch
53-
54-
## Configuration
55-
56-
All configuration is handled in a single `config.yml` file, also stored in the `/admin` folder. A simple version might look like this:
57-
58-
``` yaml
59-
backend:
60-
name: github
61-
repo: owner/repo # Path to your Github repository
62-
branch: master # Branch to update (master by default)
63-
64-
media_folder: "img/uploads" # Folder where user uploaded files should go
65-
66-
collections: # A list of collections the CMS should be able to edit
67-
- name: "post" # Used in routes, e.g., /admin/collections/:slug/edit
68-
label: "Post" # Used in the UI, e.g., "New Post"
69-
folder: "_posts" # The path to the folder where the documents are stored
70-
create: true # Allow users to create new documents in this collection
71-
fields: # The fields each document in this collection have
72-
- {label: "Title", name: "title", widget: "string", tagname: "h1"}
73-
- {label: "Body", name: "body", widget: "markdown"}
74-
- {label: "Foo", name: "foo", widget: "foo"}
75-
- {label: "Publish Date", name: "date", widget: "datetime"}
76-
```
77-
78-
### Backend
79-
80-
Because Netlify CMS is a wrapper for the GitHub API, the "backend" is a repo stored on GitHub. *(Using a different Git host? File a [feature request](https://github.com/netlify/netlify-cms/issues), or [help us add it](https://github.com/netlify/netlify-cms/blob/master/CONTRIBUTING.md)!)* For authentication, you can connect to GitHub using Netlify’s [Authentication Provider feature](https://www.netlify.com/docs/authentication-providers), or you can roll your own.
81-
82-
### Collections
83-
84-
All content managed by Netlify CMS is organized in Collections (groups of files), such as:
85-
86-
* blog posts
87-
* portfolio samples
88-
* product listings
89-
* podcast episodes
90-
91-
You point to where the files are stored, and specify the fields that define them. The `body` field typically stores the main text of a file, while any other fields are included at the top of the document in the front matter. They can be required, optional, or hidden, and can have preset defaults.
92-
93-
### Widgets
94-
95-
Widgets define the data type and interface for entry fields. Netlify CMS comes with several built-in [widgets](/docs/widgets).
96-
97-
## Customization
98-
99-
Netlify CMS exposes a `window.CMS` global object that you can use to register custom widgets, previews, and editor plugins. The available methods are:
100-
101-
* `registerPreviewStyle`: register a custom stylesheet to match the editor preview pane to your site style.
102-
103-
* `registerPreviewTemplate`: registers a template to determine how fields are displayed in the preview, customizable for each collection.
104-
105-
* `registerWidget`: registers a custom widget.
106-
107-
* `registerEditorComponent`: adds a block component to the Markdown editor.
22+
- Get a feel for the UI in the [demo site](https://cms-demo.netlify.com). (No login required—click the login button to go straight to the CMS editor UI.)
23+
- [Start with a template](https://www.netlifycms.org/docs/start-with-a-template/) to make a Netlify CMS-enabled site of your own.
24+
- Configure your existing site by following a [tutorial](https://www.netlifycms.org/docs/add-to-your-site/) or checking [configuration options](https://www.netlifycms.org/docs/configuration-options).
25+
- Ask questions and share ideas in the Netlify CMS community on [Gitter](https://gitter.im/netlify/netlifycms).
26+
- Get involved in new developments and become a [contributor](https://docs-starters--netlify-cms-www.netlify.com/docs/contributor-guide/).

0 commit comments

Comments
 (0)