misc edits in /docs; mostly style, grammar, consistency (#489)
* misc edits in /docs; mostly style, grammar, consistency * changes per reviewers requests * removed .md ext from links in 2 files per request
This commit is contained in:
committed by
Jessica Parsons
parent
b283f6931f
commit
6ad6bfd094
@ -2,14 +2,14 @@
|
||||
|
||||
Netlify CMS is a Content Management System for static sites, allowing collaborators to create, edit, review, and publish content without writing code or dealing with version control. It brings the ease of WordPress-style editing to the simplicity and speed of static sites.
|
||||
|
||||
At its core, Netlify CMS is an open-source React app that acts as a wrapper for the Git workflow, using the GitHub API. This allows for many advantages, including:
|
||||
At its core, Netlify CMS is an open-source React app that acts as a wrapper for the Git workflow, using the GitHub API. This provides many advantages, including:
|
||||
|
||||
* **Fast, web-based UI** - with rich-text editing, real-time preview, and drag-and-drop media uploads
|
||||
* **Platform agnostic** - works with most static site generators
|
||||
* **Easy installation** - add two files to your site and hook up the backend by including in your build process or linking to our CDN
|
||||
* **Modern authentication** - using GitHub and JSON web tokens
|
||||
* **Flexible content types** - specify an unlimited number of content types with custom fields
|
||||
* **Fully extensible** - create custom-styled previews, UI widgets, and editor plugins
|
||||
* **Fast, web-based UI:** with rich-text editing, real-time preview, and drag-and-drop media uploads.
|
||||
* **Platform agnostic:** works with most static site generators.
|
||||
* **Easy installation:** add two files to your site and hook up the backend by including in your build process or linking to our CDN.
|
||||
* **Modern authentication:** using GitHub and JSON web tokens.
|
||||
* **Flexible content types:** specify an unlimited number of content types with custom fields.
|
||||
* **Fully extensible:** create custom-styled previews, UI widgets, and editor plugins.
|
||||
|
||||
# Core Concepts
|
||||
|
||||
@ -38,9 +38,9 @@ The JS is also available via npm and can be integrated into your regular build p
|
||||
|
||||
### Editorial Workflow
|
||||
|
||||
Netlify CMS has an optional [editorial workflow](https://github.com/netlify/netlify-cms/blob/master/docs/editorial-workflow.md) that translates common Git commands into familiar language in a simple UI:
|
||||
Netlify CMS has an optional [editorial workflow](/docs/editorial-workflow) that translates common Git commands into familiar language in a simple UI:
|
||||
|
||||
Actions in Netlify UI... | Perform these Git actions
|
||||
Actions in Netlify UI ... | Perform these Git actions
|
||||
--- | ---
|
||||
Save draft | Commits to a new branch, and opens a pull request
|
||||
Edit draft | Pushes another commit to the draft branch/pull request
|
||||
@ -59,8 +59,8 @@ backend:
|
||||
media_folder: "img/uploads" # Folder where user uploaded files should go
|
||||
|
||||
collections: # A list of collections the CMS should be able to edit
|
||||
- name: "post" # Used in routes, ie.: /admin/collections/:slug/edit
|
||||
label: "Post" # Used in the UI, ie.: "New Post"
|
||||
- name: "post" # Used in routes, e.g., /admin/collections/:slug/edit
|
||||
label: "Post" # Used in the UI, e.g., "New Post"
|
||||
folder: "_posts" # The path to the folder where the documents are stored
|
||||
create: true # Allow users to create new documents in this collection
|
||||
fields: # The fields each document in this collection have
|
||||
@ -76,7 +76,7 @@ Because Netlify CMS is a wrapper for the GitHub API, the "backend" is a repo sto
|
||||
|
||||
### Collections
|
||||
|
||||
All content managed by Netlify CMS is organized in Collections—groups of files such as:
|
||||
All content managed by Netlify CMS is organized in Collections (groups of files), such as:
|
||||
|
||||
* blog posts
|
||||
* portfolio samples
|
||||
@ -93,11 +93,11 @@ Widgets define the data type and interface for entry fields. Netlify CMS comes w
|
||||
|
||||
Netlify CMS exposes a `window.CMS` global object that you can use to register custom widgets, previews, and editor plugins. The available methods are:
|
||||
|
||||
* `registerPreviewStyle` - register a custom stylesheet to match the editor preview pane to your site style
|
||||
* `registerPreviewStyle`: register a custom stylesheet to match the editor preview pane to your site style.
|
||||
|
||||
* `registerPreviewTemplate` - registers a template to determine how fields are displayed in the preview, customizable for each collection
|
||||
* `registerPreviewTemplate`: registers a template to determine how fields are displayed in the preview, customizable for each collection.
|
||||
|
||||
* `registerWidget` - registers a custom widget
|
||||
* `registerWidget`: registers a custom widget.
|
||||
|
||||
* `registerEditorComponent` - adds a block component to the Markdown editor
|
||||
* `registerEditorComponent`: adds a block component to the Markdown editor.
|
||||
|
||||
|
Reference in New Issue
Block a user