config.yml
file:backend
settings in your Netlify CMS config.yml
file as described in Step 2 of the Git Gateway with Netlify Identity instructions above.github
backend allows CMS users to log in directly with their GitHub account. Note that all users must have push access to your content repository for this to work.config.yml
file:context
of a commit's statuses and infers one that seems to represent a deploy preview. If you need to customize this behavior, you can specify which context to look for using preview_context
:"context"
is "my-provider/deployment"
.config.yml
file, in the folder where you access the editor UI (usually in the /admin
folder).backend
option specifies how to access the content for your site, including authentication. Full details and code samples can be found in Backends.publish_mode
option allows you to enable "Editorial Workflow" mode for more control over the content publishing phases. All unpublished entries will be arranged in a board according to their status, and they can be further reviewed and edited before going live.config.yml
file:cms/collectionName/entrySlug
), and opens a pull requestmedia_folder
option specifies the folder path where uploaded files should be saved, relative to the base of the repo.public_folder
option specifies the folder path where the files uploaded by the media library will be accessed, relative to the base of the built site. For fields controlled by [file] or [image] widgets, the value of the field is generated by prepending this path to the filename of the selected file. Defaults to the value of media_folder
, with an opening /
if one is not already included.avatar
to upload and select an image called philosoraptor.png
, the image would be saved to the repository at /static/images/uploads/philosoraptor.png
, and the avatar
field for the file would be set to /images/uploads/philosoraptor.png
.https://netlify.com/media
should you wish, however in general this is not advisable as content should have relative paths to other content.media_library
property, and its value should be an object with at least a name
property. A config
property can also be used for options that should be passed to the library in use.site_url
setting should provide a URL to your published site. May be used by the CMS for various functionality. Used together with a collection's preview_path
to create links to live content.display_url
setting is specified, the CMS UI will include a link in the fixed area at the top of the page, allowing content authors to easily return to your main site. The text of the link consists of the URL without the protocol portion (e.g., your-site.com
).site_url
.logo_url
setting is specified, the CMS UI will change the logo displayed at the top of the login page, allowing you to brand the CMS with your own logo. logo_url
is assumed to be a URL to an image file.en
.config.yml
:When importingnetlify-cms
all locales are registered by default (so you only need to update yourconfig.yml
).
search
property to false
.true
slug
option allows you to change how filenames for entries are created and sanitized. It also applies to filenames of media inserted via the default media library.
For modifying the actual data in a slug, see the per-collection option below.slug
accepts multiple options:encoding
unicode
(default): Sanitize filenames (slugs) according to RFC3987 and the WHATWG URL spec. This spec allows non-ASCII (or non-Latin) characters to exist in URLs.ascii
: Sanitize filenames (slugs) according to RFC3986. The only allowed characters are (0-9, a-z, A-Z, _
, -
, ~
).clean_accents
: Set to true
to remove diacritics from slug characters before sanitizing. This is often helpful when using ascii
encoding.sanitize_replacement
: The replacement string used to substitute unsafe characters, defaults to -
.collections
setting is the heart of your Netlify CMS configuration, as it determines how content types and editor fields in the UI generate files and content in your repository. Each collection you configure displays in the left sidebar of the Content page of the editor UI, in the order they are entered into your Netlify CMS config.yml
file.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)identifier_field
: see detailed description belowlabel
: 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
description
: optional text, displayed below the label when viewing a collectionfiles
or folder
(requires one of these): specifies the collection type and location; details in Collection Types​create
: for folder
collections only; true
allows users to create new items in the collection; defaults to false
publish
: for publish_mode: editorial_workflow
only; false
hides UI publishing controls for a collection; defaults to true
hide
: true
hides a collection in the CMS UI; defaults to false
. Useful when using the relation widget to hide referenced collections.delete
: false
prevents users from deleting items in a collection; defaults to true
extension
: see detailed description belowformat
: see detailed description belowfrontmatter_delimiter
: see detailed description under format
slug
: see detailed description belowpreview_path
: see detailed description belowpreview_path_date_field
: see detailed description belowfields
(required): see detailed description beloweditor
: see detailed description belowsummary
: see detailed description belowsortable_fields
: see detailed description belowview_filters
: see detailed description belowview_groups
: see detailed description belowidentifier_field
"title"
that serves as an identifier for the entry. The identifier field serves as an entry's title when viewing a list of entries, and is used in slug creation. If you would like to use a field other than "title"
as the identifier, you can set identifier_field
to the name of the other field.extension
and format
extension
determines the file extension searched for when finding existing entries in a folder collection and it determines the file extension used to save new collection items. It accepts the following values: yml
, yaml
, toml
, json
, md
, markdown
, html
.extension
not included in the list above, as long as the collection files can be parsed and saved in one of the supported formats below.format
determines how collection files are parsed and saved. It will be inferred if the extension
field or existing collection file extensions match one of the supported extensions above. It accepts the following values:yml
or yaml
: parses and saves files as YAML-formatted data files; saves with yml
extension by defaulttoml
: parses and saves files as TOML-formatted data files; saves with toml
extension by defaultjson
: parses and saves files as JSON-formatted data files; saves with json
extension by defaultfrontmatter
: parses files and saves files with data frontmatter followed by an unparsed body text (edited using a body
field); saves with md
extension by default; default for collections that can't be inferred. Collections with frontmatter
format (either inferred or explicitly set) can parse files with frontmatter in YAML, TOML, or JSON format. However, they will be saved with YAML frontmatter.yaml-frontmatter
: same as the frontmatter
format above, except frontmatter will be both parsed and saved only as YAML, followed by unparsed body text. The default delimiter for this option is ---
.toml-frontmatter
: same as the frontmatter
format above, except frontmatter will be both parsed and saved only as TOML, followed by unparsed body text. The default delimiter for this option is +++
.json-frontmatter
: same as the frontmatter
format above, except frontmatter will be both parsed and saved as JSON, followed by unparsed body text. The default delimiter for this option is {
}
.frontmatter_delimiter
~~~
. If you need different beginning and ending delimiters, you can use an array like ["(", ")"]
.slug
slug
option specifies a template for generating new filenames based on a file's creation date and title
field. (This means that all collections with create: true
must have a title
field (a different field can be used via identifier_field
).{{title}}
. If a field name conflicts with a built in template tag name - for example, if you have a field named slug
, and would like to reference that field via {{slug}}
, you can do so by adding the explicit fields.
prefix, eg. {{fields.slug}}
.{{author}}
{{slug}}
: a url-safe version of the title
field (or identifier field) for the file{{year}}
: 4-digit year of the file creation date{{month}}
: 2-digit month of the file creation date{{day}}
: 2-digit day of the month of the file creation date{{hour}}
: 2-digit hour of the file creation date{{minute}}
: 2-digit minute of the file creation date{{second}}
: 2-digit second of the file creation datepreview_path
{{slug}}
is the entire slug for the current entry (not just the url-safe identifier, as is the case with slug
configuration){{year}}
and {{month}}
, are pulled from a date field in your entry, and may require additional configuration - see preview_path_date_field
for details. If a date template tag is used and no date can be found, preview_path
will be ignored.{{dirname}}
The path to the file's parent directory, relative to the collection's folder
.{{filename}}
The file name without the extension part.{{extension}}
The file extension.preview_path_date_field
preview_path
. If this field is not provided and preview_path
contains date-based template tags (eg. {{year}}
), Netlify CMS will attempt to infer a usable date field by checking for common date field names, such as date
. If you find that you need to specify a date field, you can use preview_path_date_field
to tell Netlify CMS which field to use for preview path template tags.fields
fields
option maps editor UI widgets to field-value pairs in the saved file. The order of the fields in your Netlify CMS config.yml
file determines their order in the editor UI and in the saved file.fields
accepts a list of collection objects, each with the following options:name
(required): unique identifier for the field, used as the key when referenced in other contexts (like the relation widget)label
: label for the field in the editor UI; defaults to the value of name
default
: specify a default value for a field; available for most widget types (see Widgets for details on each widget type). Please note that field default value only works for folder collection type.required
: specify as false
to make a field optional; defaults to true
pattern
: add field validation by specifying a list with a regex pattern and an error message; more extensive validation can be achieved with custom widgets​comment
: optional comment to add before the field (only supported for yaml
)body
. This special field represents the section of the document (usually markdown) that comes after the frontmatter.editor
preview
: set to false
to disable the preview pane for this collection or file; defaults to true
summary
slug
field, a string with templates can be used to include values of different fields, e.g. {{title}}
. This option over-rides the default of title
field and identifier_field
.{{dirname}}
The path to the file's parent directory, relative to the collection's folder
.{{filename}}
The file name without the extension part.{{extension}}
The file extension.{{commit_date}}
The file commit date on supported backends (git based backends).{{commit_author}}
The file author date on supported backends (git based backends).sortable_fields
title
, date
, author
and description
fields and will also show Update On
sort field in git based backends.author
field can't be inferred commit author will be used.view_filters
view_groups