gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

949 document hide preview by default (#1219)

Browse Source 
* document config option to hide preview by default

* document config option to hide preview pane by default

* revise wording to specify preview disables entirely for a collection

* adjust wording of editor section to be more consistent with other settings
sections

* add note about defaulting to true
This commit is contained in:
Jeremy Bise 2018-04-03 15:46:10 -04:00 committed by Jessica Parsons
parent f948f7a408
commit 1e9b666baf
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/site/content/docs/configuration-options.md
View File

@ -99,6 +99,7 @@ The `collections` setting is the heart of your Netlify CMS configuration, as it
- `frontmatter_delimiter`: see detailed description under `format` - `frontmatter_delimiter`: see detailed description under `format`
- `slug`: see detailed description below - `slug`: see detailed description below
- `fields` (required): see detailed description below - `fields` (required): see detailed description below
- `editor`: see detailed description below
The last few options require more detailed information. The last few options require more detailed information.
@ -168,3 +169,15 @@ fields:
- {label: "Body", name: "body", widget: "markdown"} - {label: "Body", name: "body", widget: "markdown"}
``` ```
### `editor`
This setting changes options for the editor view of the collection. It has one option so far:
- `preview`: set to `false` to disable the preview pane for this collection; defaults to `true`
**Example:**
```yaml
editor:
preview: false
```