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

Add description option to collections docs (#1812)

Browse Source
This commit is contained in:
Bennaci Oussama 2018-10-16 21:40:45 +01:00 committed by Tom Rutgers
parent 926d9147ce
commit 3514bc5e0b
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
website/content/docs/configuration-options.md
View File

@ -123,8 +123,9 @@ The `collections` setting is the heart of your Netlify CMS configuration, as it
`collections` accepts a list of collection objects, each with the following options: `collections` accepts a list of collection objects, each with the following options:
- `name` (required): unique identifier for the collection, used as the key when referenced in other contexts (like the [relation widget](../widgets/#relation)) - `name` (required): unique identifier for the collection, used as the key when referenced in other contexts (like the [relation widget](../widgets/#relation))
- `Label`: label for the collection in the editor UI; defaults to the value of `name` - `label`: label for the collection in the editor UI; defaults to the value of `name`
- `label_singular`: singular label for certain elements in the editor; defaults to the value of `label` - `label_singular`: singular label for certain elements in the editor; defaults to the value of `label`
- `description`: optional text, displayed below the label when viewing a collection
- `file` or `folder` (requires one of these): specifies the collection type and location; details in [Collection Types](../collection-types) - `file` or `folder` (requires one of these): specifies the collection type and location; details in [Collection Types](../collection-types)
- `filter`: optional filter for `folder` collections; details in [Collection Types](../collection-types) - `filter`: optional filter for `folder` collections; details in [Collection Types](../collection-types)
- `create`: for `folder` collections only; `true` allows users to create new items in the collection; defaults to `false` - `create`: for `folder` collections only; `true` allows users to create new items in the collection; defaults to `false`