Netlify config
Netlify YAML config
**/admin/config*.yml
Validate
Check your file against this schema
Opens the validator with this schema already loaded. Paste your
**/admin/config*.yml and it validates in your browser — nothing is uploaded.
Reference
Fields
Generated directly from the schema, following local
$refs, to two levels of nesting.
| Field | Type | Description |
|---|---|---|
backendrequired | object | specifies how to access the content for your site, including authentication |
local_backend | boolean | Set this property to connect Netlify to a local Git repo instead of a live one |
publish_mode | any | — |
media_folderrequired | string | specifies the folder path where uploaded files should be saved, relative to the base of the repo. |
public_folder | string | 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 |
media_library | object | Media library integrations are configured via the 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. |
media_library.namerequired | string | — |
media_library.config | object | — |
site_url | string | 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 | string | When the 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 |
logo_url | string | Logo at the top of the login page. Assumed to be a URL to an image file |
locale | string | — default: "en" |
show_preview_links | boolean | shows Deploy Preview Links |
slug | object | For folder collections where users can create new items, the 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 |
slug.encoding | enum | 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 default: "unicode"one of: "unicode", "ascii" |
slug.clean_accents | boolean | Remove diacritics from slug characters before sanitizing. This is often helpful when using ascii encoding. |
slug.sanitize_replacement | string | The replacement string used to substitute unsafe characters; defaults to - |
collectionsrequired | array | The 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 |
editor | object | This setting changes options for the editor view of the collection. It has one option so far: preview |
editor.preview | boolean | Enable preview pane for this collection; defaults to true default: true |
summary | string | This setting allows the customization of the collection list view. Similar to the 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 |
sortableFields | array | An optional list of sort fields to show in the UI. Defaults to inferring title, date, author and description fields and will also show Update On sort field in git based backends. When author field can't be inferred commit author will be |
view_filters | array | An optional list of predefined view filters to show in the UI. Defaults to an empty list. |
Audit
What we found in this schema
- Declared draft: draft-07
- Validates cleanly against its own meta-schema.
- 52 properties, 83% carrying a description, max nesting depth 6.
Standards
Specification sections for the keywords in this schema
| Keyword | Document | Section |
|---|---|---|
$id | JSON Schema Core, draft 2020-12 | §8.2.1 — The "$id" Keyword |
$ref | JSON Schema Core, draft 2020-12 | §8.2.3.1 — Direct References with "$ref" |
$schema | JSON Schema Core, draft 2020-12 | §8.1.1 — "$schema" |
default | JSON Schema Validation, draft 2020-12 | §9.2 — "default" |
description | JSON Schema Validation, draft 2020-12 | §9.1 — "title" and "description" |
enum | JSON Schema Validation, draft 2020-12 | §6.1.2 — "enum" |
format | JSON Schema Validation, draft 2020-12 | §7 — Vocabularies for Semantic Content With "format" |
items | JSON Schema Core, draft 2020-12 | §10.3.1.2 — "items" |
oneOf | JSON Schema Core, draft 2020-12 | §10.2.1.3 — "oneOf" |
pattern | JSON Schema Validation, draft 2020-12 | §6.3.3 — "pattern" |
properties | JSON Schema Core, draft 2020-12 | §10.3.2.1 — "properties" |
required | JSON Schema Validation, draft 2020-12 | §6.5.3 — "required" |
type | JSON Schema Validation, draft 2020-12 | §6.1.1 — "type" |
Documents
- JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
- JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
- RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
- RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.
Source
Attribution
This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.