@sveltia/cms 0.87.3 → 0.87.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +57 -28
  2. package/dist/sveltia-cms.js +72 -72
  3. package/dist/sveltia-cms.js.map +1 -1
  4. package/dist/sveltia-cms.mjs +70 -70
  5. package/dist/sveltia-cms.mjs.map +1 -1
  6. package/package.json +1 -1
  7. package/schema/sveltia-cms.json +1160 -580
  8. package/types/public.d.ts +117 -69
package/schema/sveltia-cms.json CHANGED
@@ -7,11 +7,13 @@
7
7
  "properties": {
8
8
  "load_config_file": {
9
9
  "type": "boolean",
10
- "description": "Whether to load YAML/JSON site configuration file(s) when manually initializing the CMS. This works only in the `CMS.init()` method’s `config` option. Default: `true`."
10
+ "description": "Whether to load YAML/JSON site configuration file(s) when [manually initializing the CMS](https://decapcms.org/docs/manual-initialization/). This works only in the `CMS.init()` method’s `config` option. Default: `true`.",
11
+ "markdownDescription": "Whether to load YAML/JSON site configuration file(s) when [manually initializing the CMS](https://decapcms.org/docs/manual-initialization/). This works only in the `CMS.init()` method’s `config` option. Default: `true`."
11
12
  },
12
13
  "backend": {
13
14
  "$ref": "#/definitions/BackendOptions",
14
- "description": "Backend options."
15
+ "description": "Backend options.",
16
+ "markdownDescription": "Backend options."
15
17
  },
16
18
  "publish_mode": {
17
19
  "type": "string",
@@ -20,15 +22,18 @@
20
22
  "editorial_workflow",
21
23
  ""
22
24
  ],
23
- "description": "Publish mode. An empty string is the same as `simple`. Default: `simple`."
25
+ "description": "Publish mode. An empty string is the same as `simple`. Default: `simple`.",
26
+ "markdownDescription": "Publish mode. An empty string is the same as `simple`. Default: `simple`."
24
27
  },
25
28
  "media_folder": {
26
29
  "type": "string",
27
- "description": "Global internal media folder path, relative to the project’s root directory."
30
+ "description": "Global internal media folder path, relative to the project’s root directory.",
31
+ "markdownDescription": "Global internal media folder path, relative to the project’s root directory."
28
32
  },
29
33
  "public_folder": {
30
34
  "type": "string",
31
- "description": "Global public media folder path, relative to the project’s public URL. It must be an absolute path starting with `/`. Default: `media_folder` option value."
35
+ "description": "Global public media folder path, relative to the project’s public URL. It must be an absolute path starting with `/`. Default: `media_folder` option value.",
36
+ "markdownDescription": "Global public media folder path, relative to the project’s public URL. It must be an absolute path starting with `/`. Default: `media_folder` option value."
32
37
  },
33
38
  "media_library": {
34
39
  "anyOf": [
@@ -38,11 +43,13 @@
38
43
  "properties": {
39
44
  "name": {
40
45
  "$ref": "#/definitions/MediaLibraryName",
41
- "description": "Library name."
46
+ "description": "Library name.",
47
+ "markdownDescription": "Library name."
42
48
  },
43
49
  "config": {
44
50
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
45
- "description": "Configuration for the default media library."
51
+ "description": "Configuration for the default media library.",
52
+ "markdownDescription": "Configuration for the default media library."
46
53
  }
47
54
  },
48
55
  "required": [
@@ -55,23 +62,28 @@
55
62
  "properties": {
56
63
  "name": {
57
64
  "$ref": "#/definitions/MediaLibraryName",
58
- "description": "Library name."
65
+ "description": "Library name.",
66
+ "markdownDescription": "Library name."
59
67
  },
60
68
  "output_filename_only": {
61
69
  "type": "boolean",
62
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
70
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
71
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
63
72
  },
64
73
  "use_transformations": {
65
74
  "type": "boolean",
66
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
75
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
76
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
67
77
  },
68
78
  "use_secure_url": {
69
79
  "type": "boolean",
70
- "description": "Whether to use an HTTP URL. Default: `true`."
80
+ "description": "Whether to use an HTTP URL. Default: `true`.",
81
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
71
82
  },
72
83
  "config": {
73
84
  "type": "object",
74
- "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
85
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
86
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
75
87
  }
76
88
  },
77
89
  "required": [
@@ -84,15 +96,18 @@
84
96
  "properties": {
85
97
  "name": {
86
98
  "$ref": "#/definitions/MediaLibraryName",
87
- "description": "Library name."
99
+ "description": "Library name.",
100
+ "markdownDescription": "Library name."
88
101
  },
89
102
  "config": {
90
103
  "type": "object",
91
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
104
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
105
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
92
106
  },
93
107
  "settings": {
94
108
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
95
- "description": "Integration settings."
109
+ "description": "Integration settings.",
110
+ "markdownDescription": "Integration settings."
96
111
  }
97
112
  },
98
113
  "required": [
@@ -105,14 +120,16 @@
105
120
  "properties": {
106
121
  "name": {
107
122
  "$ref": "#/definitions/MediaLibraryName",
108
- "description": "Library name."
123
+ "description": "Library name.",
124
+ "markdownDescription": "Library name."
109
125
  },
110
126
  "providers": {
111
127
  "type": "array",
112
128
  "items": {
113
129
  "$ref": "#/definitions/StockAssetProviderName"
114
130
  },
115
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
131
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
132
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
116
133
  }
117
134
  },
118
135
  "required": [
@@ -120,31 +137,38 @@
120
137
  ]
121
138
  }
122
139
  ],
123
- "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
140
+ "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries.",
141
+ "markdownDescription": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
124
142
  },
125
143
  "media_libraries": {
126
144
  "$ref": "#/definitions/MediaLibraries",
127
- "description": "Unified media library option that supports multiple libraries."
145
+ "description": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details.",
146
+ "markdownDescription": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details."
128
147
  },
129
148
  "site_url": {
130
149
  "type": "string",
131
- "description": "Site URL. Default: current site’s origin (`location.origin`)."
150
+ "description": "Site URL. Default: current site’s origin ([`location.origin`](https://developer.mozilla.org/en-US/docs/Web/API/Location/origin)).",
151
+ "markdownDescription": "Site URL. Default: current site’s origin ([`location.origin`](https://developer.mozilla.org/en-US/docs/Web/API/Location/origin))."
132
152
  },
133
153
  "display_url": {
134
154
  "type": "string",
135
- "description": "Site URL linked from the UI. Default: `site_url` option value."
155
+ "description": "Site URL linked from the UI. Default: `site_url` option value.",
156
+ "markdownDescription": "Site URL linked from the UI. Default: `site_url` option value."
136
157
  },
137
158
  "logo_url": {
138
159
  "type": "string",
139
- "description": "Absolute URL or absolute path to the site logo that will be displayed on the entrance page and the browser’s tab (favicon). A square image works best. Default: Sveltia logo."
160
+ "description": "Absolute URL or absolute path to the site logo that will be displayed on the entrance page and the browser’s tab (favicon). A square image works best. Default: Sveltia logo.",
161
+ "markdownDescription": "Absolute URL or absolute path to the site logo that will be displayed on the entrance page and the browser’s tab (favicon). A square image works best. Default: Sveltia logo."
140
162
  },
141
163
  "show_preview_links": {
142
164
  "type": "boolean",
143
- "description": "Whether to show site preview links. Default: `true`."
165
+ "description": "Whether to show site preview links. Default: `true`.",
166
+ "markdownDescription": "Whether to show site preview links. Default: `true`."
144
167
  },
145
168
  "slug": {
146
169
  "$ref": "#/definitions/SlugOptions",
147
- "description": "Entry slug options."
170
+ "description": "Entry slug options.",
171
+ "markdownDescription": "Entry slug options."
148
172
  },
149
173
  "collections": {
150
174
  "type": "array",
@@ -158,7 +182,8 @@
158
182
  }
159
183
  ]
160
184
  },
161
- "description": "Set of collections. The list can also contain dividers, which are used to group collections in the collection list."
185
+ "description": "Set of collections. The list can also contain dividers, which are used to group collections in the collection list.",
186
+ "markdownDescription": "Set of collections. The list can also contain dividers, which are used to group collections in the collection list."
162
187
  },
163
188
  "singletons": {
164
189
  "type": "array",
@@ -172,19 +197,23 @@
172
197
  }
173
198
  ]
174
199
  },
175
- "description": "Set of singleton files, such as the site configuration file or the homepage file. They are not part of any collection and can be accessed directly through the collection list. The list can also contain dividers."
200
+ "description": "Set of singleton files, such as the site configuration file or the homepage file. They are not part of any collection and can be accessed directly through the collection list. The list can also contain dividers. See our [README](https://github.com/sveltia/sveltia-cms#using-singletons) for details.",
201
+ "markdownDescription": "Set of singleton files, such as the site configuration file or the homepage file. They are not part of any collection and can be accessed directly through the collection list. The list can also contain dividers. See our [README](https://github.com/sveltia/sveltia-cms#using-singletons) for details."
176
202
  },
177
203
  "i18n": {
178
204
  "$ref": "#/definitions/I18nOptions",
179
- "description": "Global i18n options."
205
+ "description": "Global i18n options.",
206
+ "markdownDescription": "Global i18n options."
180
207
  },
181
208
  "editor": {
182
209
  "$ref": "#/definitions/EditorOptions",
183
- "description": "Editor view options."
210
+ "description": "Editor view options.",
211
+ "markdownDescription": "Editor view options."
184
212
  },
185
213
  "output": {
186
214
  "$ref": "#/definitions/OutputOptions",
187
- "description": "Data output options."
215
+ "description": "Data output options. See our [README](https://github.com/sveltia/sveltia-cms#controlling-data-output) for details.",
216
+ "markdownDescription": "Data output options. See our [README](https://github.com/sveltia/sveltia-cms#controlling-data-output) for details."
188
217
  }
189
218
  },
190
219
  "required": [
@@ -193,42 +222,51 @@
193
222
  "collections"
194
223
  ],
195
224
  "additionalProperties": false,
196
- "description": "Site configuration."
225
+ "description": "Site configuration.",
226
+ "markdownDescription": "Site configuration."
197
227
  },
198
228
  "BackendOptions": {
199
229
  "type": "object",
200
230
  "properties": {
201
231
  "name": {
202
232
  "$ref": "#/definitions/BackendName",
203
- "description": "Backend name."
233
+ "description": "Backend name.",
234
+ "markdownDescription": "Backend name."
204
235
  },
205
236
  "repo": {
206
237
  "type": "string",
207
- "description": "Repository identifier. Required for Git backends. GitHub/Gitea: organization/user name and repository name joined by a slash, e.g. `owner/repo`. GitLab: namespace and project name joined by a slash, e.g. `group/project` or `group/subgroup/project`."
238
+ "description": "Repository identifier. Required for Git backends. GitHub/Gitea: organization/user name and repository name joined by a slash, e.g. `owner/repo`. GitLab: namespace and project name joined by a slash, e.g. `group/project` or `group/subgroup/project`.",
239
+ "markdownDescription": "Repository identifier. Required for Git backends. GitHub/Gitea: organization/user name and repository name joined by a slash, e.g. `owner/repo`. GitLab: namespace and project name joined by a slash, e.g. `group/project` or `group/subgroup/project`."
208
240
  },
209
241
  "branch": {
210
242
  "type": "string",
211
- "description": "Git branch name. If omitted, the default branch, usually `main` or `master`, will be used. Git backends only."
243
+ "description": "Git branch name. If omitted, the default branch, usually `main` or `master`, will be used. Git backends only.",
244
+ "markdownDescription": "Git branch name. If omitted, the default branch, usually `main` or `master`, will be used. Git backends only."
212
245
  },
213
246
  "api_root": {
214
247
  "type": "string",
215
- "description": "REST API endpoint for the backend. Git backends only. Required when using GitHub Enterprise Server, a self-hosted GitLab/Gitea instance. Default: `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab) or `https://gitea.com/api/v1` (Gitea)."
248
+ "description": "REST API endpoint for the backend. Git backends only. Required when using GitHub Enterprise Server, a self-hosted GitLab/Gitea instance. Default: `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab) or `https://gitea.com/api/v1` (Gitea).",
249
+ "markdownDescription": "REST API endpoint for the backend. Git backends only. Required when using GitHub Enterprise Server, a self-hosted GitLab/Gitea instance. Default: `https://api.github.com` (GitHub), `https://gitlab.com/api/v4` (GitLab) or `https://gitea.com/api/v1` (Gitea)."
216
250
  },
217
251
  "graphql_api_root": {
218
252
  "type": "string",
219
- "description": "GraphQL API endpoint for the backend. Git backends only. Default: inferred from `api_root` option value."
253
+ "description": "GraphQL API endpoint for the backend. Git backends only. Default: inferred from `api_root` option value.",
254
+ "markdownDescription": "GraphQL API endpoint for the backend. Git backends only. Default: inferred from `api_root` option value."
220
255
  },
221
256
  "site_domain": {
222
257
  "type": "string",
223
- "description": "Site domain used for OAuth, which will be included in the `site_id` param to be sent to the API endpoint. Git backends only. Default: `location.hostname`."
258
+ "description": "Site domain used for OAuth, which will be included in the `site_id` param to be sent to the API endpoint. Git backends only. Default: [`location.hostname`](https://developer.mozilla.org/en-US/docs/Web/API/Location/hostname).",
259
+ "markdownDescription": "Site domain used for OAuth, which will be included in the `site_id` param to be sent to the API endpoint. Git backends only. Default: [`location.hostname`](https://developer.mozilla.org/en-US/docs/Web/API/Location/hostname)."
224
260
  },
225
261
  "base_url": {
226
262
  "type": "string",
227
- "description": "OAuth base URL origin. Git backends only. Required when using an OAuth client other than Netlify, including Sveltia CMS Authenticator. Default: `https://api.netlify.com` (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea)."
263
+ "description": "OAuth base URL origin. Git backends only. Required when using an OAuth client other than Netlify, including [Sveltia CMS Authenticator](https://github.com/sveltia/sveltia-cms-auth). Default: `https://api.netlify.com` (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea).",
264
+ "markdownDescription": "OAuth base URL origin. Git backends only. Required when using an OAuth client other than Netlify, including [Sveltia CMS Authenticator](https://github.com/sveltia/sveltia-cms-auth). Default: `https://api.netlify.com` (GitHub), `https://gitlab.com` (GitLab) or `https://gitea.com/` (Gitea)."
228
265
  },
229
266
  "auth_endpoint": {
230
267
  "type": "string",
231
- "description": "OAuth base URL path. Git backends only. Default: `auth` (GitHub) or `oauth/authorize` (GitLab)."
268
+ "description": "OAuth base URL path. Git backends only. Default: `auth` (GitHub) or `oauth/authorize` (GitLab).",
269
+ "markdownDescription": "OAuth base URL path. Git backends only. Default: `auth` (GitHub) or `oauth/authorize` (GitLab)."
232
270
  },
233
271
  "auth_type": {
234
272
  "type": "string",
@@ -236,31 +274,38 @@
236
274
  "pkce",
237
275
  "implicit"
238
276
  ],
239
- "description": "OAuth authentication method. GitLab only. Default: `pkce`."
277
+ "description": "OAuth authentication method. GitLab only. Default: `pkce`.",
278
+ "markdownDescription": "OAuth authentication method. GitLab only. Default: `pkce`."
240
279
  },
241
280
  "app_id": {
242
281
  "type": "string",
243
- "description": "OAuth application ID. GitLab and Gitea only. Required for Gitea."
282
+ "description": "OAuth application ID. GitLab and Gitea only. Required for Gitea.",
283
+ "markdownDescription": "OAuth application ID. GitLab and Gitea only. Required for Gitea."
244
284
  },
245
285
  "commit_messages": {
246
286
  "$ref": "#/definitions/CommitMessages",
247
- "description": "Custom commit messages. Git backends only."
287
+ "description": "Custom commit messages. Git backends only.",
288
+ "markdownDescription": "Custom commit messages. Git backends only."
248
289
  },
249
290
  "preview_context": {
250
291
  "type": "string",
251
- "description": "Deploy preview link context. GitHub only."
292
+ "description": "Deploy preview link context. GitHub only.",
293
+ "markdownDescription": "Deploy preview link context. GitHub only."
252
294
  },
253
295
  "cms_label_prefix": {
254
296
  "type": "string",
255
- "description": "Pull request label prefix for Editorial Workflow. Git backends only. Default: `sveltia-cms/`."
297
+ "description": "Pull request label prefix for Editorial Workflow. Git backends only. Default: `sveltia-cms/`.",
298
+ "markdownDescription": "Pull request label prefix for Editorial Workflow. Git backends only. Default: `sveltia-cms/`."
256
299
  },
257
300
  "squash_merges": {
258
301
  "type": "boolean",
259
- "description": "Whether to use squash marge for Editorial Workflow. Git backends only. Default: `false`."
302
+ "description": "Whether to use squash marge for Editorial Workflow. Git backends only. Default: `false`.",
303
+ "markdownDescription": "Whether to use squash marge for Editorial Workflow. Git backends only. Default: `false`."
260
304
  },
261
305
  "open_authoring": {
262
306
  "type": "boolean",
263
- "description": "Whether to use Open Authoring. Git backends only. Default: `false`."
307
+ "description": "Whether to use Open Authoring. Git backends only. Default: `false`.",
308
+ "markdownDescription": "Whether to use Open Authoring. Git backends only. Default: `false`."
264
309
  },
265
310
  "auth_scope": {
266
311
  "type": "string",
@@ -268,18 +313,21 @@
268
313
  "repo",
269
314
  "public_repo"
270
315
  ],
271
- "description": "Authentication scope for Open Authoring. Git backends only."
316
+ "description": "Authentication scope for Open Authoring. Git backends only.",
317
+ "markdownDescription": "Authentication scope for Open Authoring. Git backends only."
272
318
  },
273
319
  "automatic_deployments": {
274
320
  "type": "boolean",
275
- "description": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments for details."
321
+ "description": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See our [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details.",
322
+ "markdownDescription": "Whether to enable or disable automatic deployments with any connected CI/CD provider, such as GitHub Actions or Cloudflare Pages. If `false`, the `[skip ci]` prefix will be added to commit messages. Git backends only. Default: `undefined`. See our [README](https://github.com/sveltia/sveltia-cms#disabling-automatic-deployments) for details."
276
323
  }
277
324
  },
278
325
  "required": [
279
326
  "name"
280
327
  ],
281
328
  "additionalProperties": false,
282
- "description": "Backend options."
329
+ "description": "Backend options.",
330
+ "markdownDescription": "Backend options."
283
331
  },
284
332
  "BackendName": {
285
333
  "anyOf": [
@@ -291,7 +339,8 @@
291
339
  "const": "test-repo"
292
340
  }
293
341
  ],
294
- "description": "Supported backend name."
342
+ "description": "Supported backend name.",
343
+ "markdownDescription": "Supported backend name."
295
344
  },
296
345
  "GitBackendName": {
297
346
  "type": "string",
@@ -300,38 +349,46 @@
300
349
  "gitlab",
301
350
  "gitea"
302
351
  ],
303
- "description": "Supported Git backend name."
352
+ "description": "Supported Git backend name.",
353
+ "markdownDescription": "Supported Git backend name."
304
354
  },
305
355
  "CommitMessages": {
306
356
  "type": "object",
307
357
  "properties": {
308
358
  "create": {
309
359
  "type": "string",
310
- "description": "Message to be used when a new entry is created."
360
+ "description": "Message to be used when a new entry is created.",
361
+ "markdownDescription": "Message to be used when a new entry is created."
311
362
  },
312
363
  "update": {
313
364
  "type": "string",
314
- "description": "Message to be used when existing entries are updated."
365
+ "description": "Message to be used when existing entries are updated.",
366
+ "markdownDescription": "Message to be used when existing entries are updated."
315
367
  },
316
368
  "delete": {
317
369
  "type": "string",
318
- "description": "Message to be used when existing entries are deleted."
370
+ "description": "Message to be used when existing entries are deleted.",
371
+ "markdownDescription": "Message to be used when existing entries are deleted."
319
372
  },
320
373
  "uploadMedia": {
321
374
  "type": "string",
322
- "description": "Message to be used when new files are uploaded/updated."
375
+ "description": "Message to be used when new files are uploaded/updated.",
376
+ "markdownDescription": "Message to be used when new files are uploaded/updated."
323
377
  },
324
378
  "deleteMedia": {
325
379
  "type": "string",
326
- "description": "Message to be used when existing files are deleted."
380
+ "description": "Message to be used when existing files are deleted.",
381
+ "markdownDescription": "Message to be used when existing files are deleted."
327
382
  },
328
383
  "openAuthoring": {
329
384
  "type": "string",
330
- "description": "Message to be used when committed via a forked repository."
385
+ "description": "Message to be used when committed via a forked repository.",
386
+ "markdownDescription": "Message to be used when committed via a forked repository."
331
387
  }
332
388
  },
333
389
  "additionalProperties": false,
334
- "description": "Custom commit messages."
390
+ "description": "Custom commit messages.",
391
+ "markdownDescription": "Custom commit messages."
335
392
  },
336
393
  "MediaLibraryName": {
337
394
  "type": "string",
@@ -341,30 +398,36 @@
341
398
  "uploadcare",
342
399
  "stock_assets"
343
400
  ],
344
- "description": "Supported media library name."
401
+ "description": "Supported media library name.",
402
+ "markdownDescription": "Supported media library name."
345
403
  },
346
404
  "DefaultMediaLibraryConfig": {
347
405
  "type": "object",
348
406
  "properties": {
349
407
  "max_file_size": {
350
408
  "type": "number",
351
- "description": "Maximum file size in bytes that can be accepted for uploading."
409
+ "description": "Maximum file size in bytes that can be accepted for uploading.",
410
+ "markdownDescription": "Maximum file size in bytes that can be accepted for uploading."
352
411
  },
353
412
  "slugify_filename": {
354
413
  "type": "boolean",
355
- "description": "Whether to rename an original asset file when saving it, according to the global `slug` option. Default: `false`, meaning that the original file name is kept by default, while Netlify/Decap CMS forces to slugify file names. If set to `true`, for example, `Hello World (1).webp` would be `hello-world-1.webp`."
414
+ "description": "Whether to rename an original asset file when saving it, according to the global `slug` option. Default: `false`, meaning that the original file name is kept by default, while Netlify/Decap CMS forces to slugify file names. If set to `true`, for example, `Hello World (1).webp` would be `hello-world-1.webp`.",
415
+ "markdownDescription": "Whether to rename an original asset file when saving it, according to the global `slug` option. Default: `false`, meaning that the original file name is kept by default, while Netlify/Decap CMS forces to slugify file names. If set to `true`, for example, `Hello World (1).webp` would be `hello-world-1.webp`."
356
416
  },
357
417
  "transformations": {
358
418
  "$ref": "#/definitions/FileTransformations",
359
- "description": "File transformation option map. The key is an original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported raster image format."
419
+ "description": "File transformation option map. The key is an original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported raster image format. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.",
420
+ "markdownDescription": "File transformation option map. The key is an original format like `png` or `jpeg`. It can also be `raster_image` that matches any supported raster image format. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details."
360
421
  }
361
422
  },
362
423
  "additionalProperties": false,
363
- "description": "Configuration for the default media library."
424
+ "description": "Configuration for the default media library.",
425
+ "markdownDescription": "Configuration for the default media library."
364
426
  },
365
427
  "FileTransformations": {
366
428
  "$ref": "#/definitions/ImageTransformations",
367
- "description": "File transformation option map."
429
+ "description": "File transformation option map.",
430
+ "markdownDescription": "File transformation option map."
368
431
  },
369
432
  "ImageTransformations": {
370
433
  "type": "object",
@@ -372,88 +435,107 @@
372
435
  "properties": {
373
436
  "svg": {
374
437
  "$ref": "#/definitions/VectorImageTransformationOptions",
375
- "description": "SVG image transformation options."
438
+ "description": "SVG image transformation options.",
439
+ "markdownDescription": "SVG image transformation options."
376
440
  },
377
441
  "raster_image": {
378
442
  "$ref": "#/definitions/RasterImageTransformationOptions",
379
- "description": "Raster image transformation options that apply to any supported raster image format."
443
+ "description": "Raster image transformation options that apply to any supported raster image format.",
444
+ "markdownDescription": "Raster image transformation options that apply to any supported raster image format."
380
445
  },
381
446
  "avif": {
382
447
  "$ref": "#/definitions/RasterImageTransformationOptions",
383
- "description": "AVIF image transformation options."
448
+ "description": "AVIF image transformation options.",
449
+ "markdownDescription": "AVIF image transformation options."
384
450
  },
385
451
  "gif": {
386
452
  "$ref": "#/definitions/RasterImageTransformationOptions",
387
- "description": "GIF image transformation options."
453
+ "description": "GIF image transformation options.",
454
+ "markdownDescription": "GIF image transformation options."
388
455
  },
389
456
  "jpeg": {
390
457
  "$ref": "#/definitions/RasterImageTransformationOptions",
391
- "description": "JPEG image transformation options."
458
+ "description": "JPEG image transformation options.",
459
+ "markdownDescription": "JPEG image transformation options."
392
460
  },
393
461
  "png": {
394
462
  "$ref": "#/definitions/RasterImageTransformationOptions",
395
- "description": "PNG image transformation options."
463
+ "description": "PNG image transformation options.",
464
+ "markdownDescription": "PNG image transformation options."
396
465
  },
397
466
  "webp": {
398
467
  "$ref": "#/definitions/RasterImageTransformationOptions",
399
- "description": "WebP image transformation options."
468
+ "description": "WebP image transformation options.",
469
+ "markdownDescription": "WebP image transformation options."
400
470
  }
401
471
  },
402
- "description": "Image transformation option map."
472
+ "description": "Image transformation option map.",
473
+ "markdownDescription": "Image transformation option map."
403
474
  },
404
475
  "VectorImageTransformationOptions": {
405
476
  "type": "object",
406
477
  "properties": {
407
478
  "optimize": {
408
479
  "type": "boolean",
409
- "description": "Whether to optimize the image."
480
+ "description": "Whether to optimize the image.",
481
+ "markdownDescription": "Whether to optimize the image."
410
482
  }
411
483
  },
412
484
  "additionalProperties": false,
413
- "description": "Vector image transformation option map."
485
+ "description": "Vector image transformation option map.",
486
+ "markdownDescription": "Vector image transformation option map."
414
487
  },
415
488
  "RasterImageTransformationOptions": {
416
489
  "type": "object",
417
490
  "properties": {
418
491
  "format": {
419
492
  "$ref": "#/definitions/RasterImageConversionFormat",
420
- "description": "New format. Default: `webp`."
493
+ "description": "New format. Default: `webp`.",
494
+ "markdownDescription": "New format. Default: `webp`."
421
495
  },
422
496
  "quality": {
423
497
  "type": "number",
424
- "description": "Image quality between 0 and 100. Default: `85`."
498
+ "description": "Image quality between 0 and 100. Default: `85`.",
499
+ "markdownDescription": "Image quality between 0 and 100. Default: `85`."
425
500
  },
426
501
  "width": {
427
502
  "type": "number",
428
- "description": "Max width. Default: original width."
503
+ "description": "Max width. Default: original width.",
504
+ "markdownDescription": "Max width. Default: original width."
429
505
  },
430
506
  "height": {
431
507
  "type": "number",
432
- "description": "Max height. Default: original height."
508
+ "description": "Max height. Default: original height.",
509
+ "markdownDescription": "Max height. Default: original height."
433
510
  }
434
511
  },
435
512
  "additionalProperties": false,
436
- "description": "Raster image transformation options."
513
+ "description": "Raster image transformation options. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details.",
514
+ "markdownDescription": "Raster image transformation options. See our [README](https://github.com/sveltia/sveltia-cms#optimizing-images-for-upload) for details."
437
515
  },
438
516
  "RasterImageConversionFormat": {
439
517
  "type": "string",
440
518
  "const": "webp",
441
- "description": "Supported raster image conversion format. We don’t support AVIF at this time because no browser supports AVIF encoding natively and `@jsquash/avif` is slow. Meanwhile, browsers other than Safari support WebP encoding and `@jsquash/webp` is relatively fast."
519
+ "description": "Supported raster image conversion format. We don’t support AVIF at this time because no browser supports AVIF encoding natively and `@jsquash/avif` is slow. Meanwhile, browsers other than Safari support WebP encoding and `@jsquash/webp` is relatively fast.",
520
+ "markdownDescription": "Supported raster image conversion format. We don’t support AVIF at this time because no browser supports AVIF encoding natively and `@jsquash/avif` is slow. Meanwhile, browsers other than Safari support WebP encoding and `@jsquash/webp` is relatively fast."
442
521
  },
443
522
  "UploadcareMediaLibrarySettings": {
444
523
  "type": "object",
445
524
  "properties": {
446
525
  "autoFilename": {
447
526
  "type": "boolean",
448
- "description": "Whether to append a file name to an output URL. Default: `false`."
527
+ "description": "Whether to append a file name to an output URL. Default: `false`.",
528
+ "markdownDescription": "Whether to append a file name to an output URL. Default: `false`."
449
529
  },
450
530
  "defaultOperations": {
451
531
  "type": "string",
452
- "description": "Transformation operations to be included in an output URL. Default: empty string."
532
+ "description": "Transformation operations to be included in an output URL. Default: empty string.",
533
+ "markdownDescription": "Transformation operations to be included in an output URL. Default: empty string."
453
534
  }
454
535
  },
455
536
  "additionalProperties": false,
456
- "description": "Settings for the Uploadcare media library."
537
+ "description": "Settings for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).",
538
+ "markdownDescription": "Settings for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/)."
457
539
  },
458
540
  "StockAssetProviderName": {
459
541
  "type": "string",
@@ -462,79 +544,95 @@
462
544
  "pixabay",
463
545
  "unsplash"
464
546
  ],
465
- "description": "Name of supported stock photo/video provider."
547
+ "description": "Name of supported stock photo/video provider.",
548
+ "markdownDescription": "Name of supported stock photo/video provider."
466
549
  },
467
550
  "MediaLibraries": {
468
551
  "type": "object",
469
552
  "properties": {
470
553
  "default": {
471
554
  "$ref": "#/definitions/DefaultMediaLibrary",
472
- "description": "Options for the default media library."
555
+ "description": "Options for the default media library.",
556
+ "markdownDescription": "Options for the default media library."
473
557
  },
474
558
  "cloudinary": {
475
559
  "$ref": "#/definitions/CloudinaryMediaLibrary",
476
- "description": "Options for the Cloudinary media library."
560
+ "description": "Options for the Cloudinary media library.",
561
+ "markdownDescription": "Options for the Cloudinary media library."
477
562
  },
478
563
  "uploadcare": {
479
564
  "$ref": "#/definitions/UploadcareMediaLibrary",
480
- "description": "Options for the Uploadcare media library."
565
+ "description": "Options for the Uploadcare media library.",
566
+ "markdownDescription": "Options for the Uploadcare media library."
481
567
  },
482
568
  "stock_assets": {
483
569
  "$ref": "#/definitions/StockAssetMediaLibrary",
484
- "description": "Options for the unified stock photo/video media library."
570
+ "description": "Options for the unified stock photo/video media library.",
571
+ "markdownDescription": "Options for the unified stock photo/video media library."
485
572
  }
486
573
  },
487
574
  "additionalProperties": false,
488
- "description": "Unified media library option that supports multiple libraries."
575
+ "description": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details.",
576
+ "markdownDescription": "Unified media library option that supports multiple libraries. See our [README](https://github.com/sveltia/sveltia-cms#configuring-multiple-media-libraries) for details."
489
577
  },
490
578
  "DefaultMediaLibrary": {
491
579
  "type": "object",
492
580
  "properties": {
493
581
  "config": {
494
582
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
495
- "description": "Configuration for the default media library."
583
+ "description": "Configuration for the default media library.",
584
+ "markdownDescription": "Configuration for the default media library."
496
585
  }
497
586
  },
498
587
  "additionalProperties": false,
499
- "description": "Options for the default media library."
588
+ "description": "Options for the default media library.",
589
+ "markdownDescription": "Options for the default media library."
500
590
  },
501
591
  "CloudinaryMediaLibrary": {
502
592
  "type": "object",
503
593
  "properties": {
504
594
  "output_filename_only": {
505
595
  "type": "boolean",
506
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
596
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
597
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
507
598
  },
508
599
  "use_transformations": {
509
600
  "type": "boolean",
510
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
601
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
602
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
511
603
  },
512
604
  "use_secure_url": {
513
605
  "type": "boolean",
514
- "description": "Whether to use an HTTP URL. Default: `true`."
606
+ "description": "Whether to use an HTTP URL. Default: `true`.",
607
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
515
608
  },
516
609
  "config": {
517
610
  "type": "object",
518
- "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
611
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
612
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
519
613
  }
520
614
  },
521
615
  "additionalProperties": false,
522
- "description": "Options for the Cloudinary media library."
616
+ "description": "Options for the [Cloudinary media library](https://decapcms.org/docs/cloudinary/).",
617
+ "markdownDescription": "Options for the [Cloudinary media library](https://decapcms.org/docs/cloudinary/)."
523
618
  },
524
619
  "UploadcareMediaLibrary": {
525
620
  "type": "object",
526
621
  "properties": {
527
622
  "config": {
528
623
  "type": "object",
529
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
624
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
625
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
530
626
  },
531
627
  "settings": {
532
628
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
533
- "description": "Integration settings."
629
+ "description": "Integration settings.",
630
+ "markdownDescription": "Integration settings."
534
631
  }
535
632
  },
536
633
  "additionalProperties": false,
537
- "description": "Options for the Uploadcare media library."
634
+ "description": "Options for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/).",
635
+ "markdownDescription": "Options for the [Uploadcare media library](https://decapcms.org/docs/uploadcare/)."
538
636
  },
539
637
  "StockAssetMediaLibrary": {
540
638
  "type": "object",
@@ -544,11 +642,13 @@
544
642
  "items": {
545
643
  "$ref": "#/definitions/StockAssetProviderName"
546
644
  },
547
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
645
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
646
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
548
647
  }
549
648
  },
550
649
  "additionalProperties": false,
551
- "description": "Options for the unified stock photo/video media library."
650
+ "description": "Options for the unified stock photo/video media library.",
651
+ "markdownDescription": "Options for the unified stock photo/video media library."
552
652
  },
553
653
  "SlugOptions": {
554
654
  "type": "object",
@@ -559,104 +659,127 @@
559
659
  "unicode",
560
660
  "ascii"
561
661
  ],
562
- "description": "Encoding option. Default: `unicode`."
662
+ "description": "Encoding option. Default: `unicode`.",
663
+ "markdownDescription": "Encoding option. Default: `unicode`."
563
664
  },
564
665
  "clean_accents": {
565
666
  "type": "boolean",
566
- "description": "Whether to remove accents. Default: `false`."
667
+ "description": "Whether to remove accents. Default: `false`.",
668
+ "markdownDescription": "Whether to remove accents. Default: `false`."
567
669
  },
568
670
  "sanitize_replacement": {
569
671
  "type": "string",
570
- "description": "String to replace sanitized characters. Default: `-`."
672
+ "description": "String to replace sanitized characters. Default: `-`.",
673
+ "markdownDescription": "String to replace sanitized characters. Default: `-`."
571
674
  }
572
675
  },
573
676
  "additionalProperties": false,
574
- "description": "Entry slug options."
677
+ "description": "Entry slug options.",
678
+ "markdownDescription": "Entry slug options."
575
679
  },
576
680
  "Collection": {
577
681
  "type": "object",
578
682
  "properties": {
579
683
  "name": {
580
684
  "type": "string",
581
- "description": "Unique identifier for the collection."
685
+ "description": "Unique identifier for the collection.",
686
+ "markdownDescription": "Unique identifier for the collection."
582
687
  },
583
688
  "label": {
584
689
  "type": "string",
585
- "description": "Label of the field to be displayed in the editor UI. Default: `name` option value."
690
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` option value.",
691
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` option value."
586
692
  },
587
693
  "label_singular": {
588
694
  "type": "string",
589
- "description": "Singular UI label. It will be Blog Post if the `label` is Blog Posts, for example. Default: `label` option value."
695
+ "description": "Singular UI label. It will be Blog Post if the `label` is Blog Posts, for example. Default: `label` option value.",
696
+ "markdownDescription": "Singular UI label. It will be Blog Post if the `label` is Blog Posts, for example. Default: `label` option value."
590
697
  },
591
698
  "description": {
592
699
  "type": "string",
593
- "description": "Short description of the collection to be displayed in the editor UI."
700
+ "description": "Short description of the collection to be displayed in the editor UI.",
701
+ "markdownDescription": "Short description of the collection to be displayed in the editor UI."
594
702
  },
595
703
  "icon": {
596
704
  "type": "string",
597
- "description": "Name of a Material Symbols icon to be displayed in the collection list."
705
+ "description": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection list.",
706
+ "markdownDescription": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection list."
598
707
  },
599
708
  "identifier_field": {
600
709
  "$ref": "#/definitions/FieldKeyPath",
601
- "description": "Field name to be used as the title and slug of an entry. Entry collection only. Default: `title`."
710
+ "description": "Field name to be used as the title and slug of an entry. Entry collection only. Default: `title`.",
711
+ "markdownDescription": "Field name to be used as the title and slug of an entry. Entry collection only. Default: `title`."
602
712
  },
603
713
  "files": {
604
714
  "type": "array",
605
715
  "items": {
606
716
  "$ref": "#/definitions/CollectionFile"
607
717
  },
608
- "description": "A set of files. File collection only."
718
+ "description": "A set of files. File collection only.",
719
+ "markdownDescription": "A set of files. File collection only."
609
720
  },
610
721
  "folder": {
611
722
  "type": "string",
612
- "description": "Base folder path relative to the project root. Entry collection only."
723
+ "description": "Base folder path relative to the project root. Entry collection only.",
724
+ "markdownDescription": "Base folder path relative to the project root. Entry collection only."
613
725
  },
614
726
  "fields": {
615
727
  "type": "array",
616
728
  "items": {
617
729
  "$ref": "#/definitions/Field"
618
730
  },
619
- "description": "Set of fields to be included in entries. Entry collection only."
731
+ "description": "Set of fields to be included in entries. Entry collection only.",
732
+ "markdownDescription": "Set of fields to be included in entries. Entry collection only."
620
733
  },
621
734
  "path": {
622
735
  "type": "string",
623
- "description": "File path relative to `folder`, without a file extension. Entry collection only."
736
+ "description": "File path relative to `folder`, without a file extension. Entry collection only.",
737
+ "markdownDescription": "File path relative to `folder`, without a file extension. Entry collection only."
624
738
  },
625
739
  "media_folder": {
626
740
  "type": "string",
627
- "description": "Internal media folder path for the collection. This overrides the global `media_folder` option."
741
+ "description": "Internal media folder path for the collection. This overrides the global `media_folder` option. It can be a relative path from the project root if it starts with a slash. Otherwise it’s a path relative to the entry. If this option is omitted, the global `media_folder` option value is used. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-media-folder-for-a-collection) for details.",
742
+ "markdownDescription": "Internal media folder path for the collection. This overrides the global `media_folder` option. It can be a relative path from the project root if it starts with a slash. Otherwise it’s a path relative to the entry. If this option is omitted, the global `media_folder` option value is used. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-media-folder-for-a-collection) for details."
628
743
  },
629
744
  "public_folder": {
630
745
  "type": "string",
631
- "description": "Public media folder path for an entry collection. This overrides the global `public_folder` option. Default: `media_folder` option value."
746
+ "description": "Public media folder path for an entry collection. This overrides the global `public_folder` option. Default: `media_folder` option value.",
747
+ "markdownDescription": "Public media folder path for an entry collection. This overrides the global `public_folder` option. Default: `media_folder` option value."
632
748
  },
633
749
  "filter": {
634
750
  "$ref": "#/definitions/CollectionFilter",
635
- "description": "Entry filter. Entry collection only."
751
+ "description": "Entry filter. Entry collection only.",
752
+ "markdownDescription": "Entry filter. Entry collection only."
636
753
  },
637
754
  "hide": {
638
755
  "type": "boolean",
639
- "description": "Whether to hide the collection in the UI. Default: `false`."
756
+ "description": "Whether to hide the collection in the UI. Default: `false`.",
757
+ "markdownDescription": "Whether to hide the collection in the UI. Default: `false`."
640
758
  },
641
759
  "create": {
642
760
  "type": "boolean",
643
- "description": "Whether to allow users to create entries in the collection. Entry collection only. Default: `false`."
761
+ "description": "Whether to allow users to create entries in the collection. Entry collection only. Default: `false`.",
762
+ "markdownDescription": "Whether to allow users to create entries in the collection. Entry collection only. Default: `false`."
644
763
  },
645
764
  "delete": {
646
765
  "type": "boolean",
647
- "description": "Whether to allow users to delete entries in the collection. Entry collection only. Default: `true`."
766
+ "description": "Whether to allow users to delete entries in the collection. Entry collection only. Default: `true`.",
767
+ "markdownDescription": "Whether to allow users to delete entries in the collection. Entry collection only. Default: `true`."
648
768
  },
649
769
  "publish": {
650
770
  "type": "boolean",
651
- "description": "Whether to show the publishing control UI for Editorial Workflow. Default: `true`."
771
+ "description": "Whether to show the publishing control UI for Editorial Workflow. Default: `true`.",
772
+ "markdownDescription": "Whether to show the publishing control UI for Editorial Workflow. Default: `true`."
652
773
  },
653
774
  "extension": {
654
775
  "$ref": "#/definitions/FileExtension",
655
- "description": "File extension. Entry collection only. Default: `md`."
776
+ "description": "File extension. Entry collection only. Default: `md`.",
777
+ "markdownDescription": "File extension. Entry collection only. Default: `md`."
656
778
  },
657
779
  "format": {
658
780
  "$ref": "#/definitions/FileFormat",
659
- "description": "File format. It should match the file extension. Default: `yaml-frontmatter`."
781
+ "description": "File format. It should match the file extension. Default: `yaml-frontmatter`.",
782
+ "markdownDescription": "File format. It should match the file extension. Default: `yaml-frontmatter`."
660
783
  },
661
784
  "frontmatter_delimiter": {
662
785
  "anyOf": [
@@ -670,19 +793,23 @@
670
793
  }
671
794
  }
672
795
  ],
673
- "description": "Delimiters to be used for the front matter format. Default: depends on the front matter type."
796
+ "description": "Delimiters to be used for the front matter format. Default: depends on the front matter type.",
797
+ "markdownDescription": "Delimiters to be used for the front matter format. Default: depends on the front matter type."
674
798
  },
675
799
  "slug": {
676
800
  "type": "string",
677
- "description": "Item slug template. Entry collection only. Default: `identifier_field` option value."
801
+ "description": "Item slug template. Entry collection only. Default: `identifier_field` option value. It’s possible to [localize the slug](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) or [use a random ID](https://github.com/sveltia/sveltia-cms#using-a-random-id-for-an-entry-slug).",
802
+ "markdownDescription": "Item slug template. Entry collection only. Default: `identifier_field` option value. It’s possible to [localize the slug](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) or [use a random ID](https://github.com/sveltia/sveltia-cms#using-a-random-id-for-an-entry-slug)."
678
803
  },
679
804
  "slug_length": {
680
805
  "type": "number",
681
- "description": "The maximum number of characters allowed for an entry slug. Entry collection only. Default: `Infinity`."
806
+ "description": "The maximum number of characters allowed for an entry slug. Entry collection only. Default: `Infinity`.",
807
+ "markdownDescription": "The maximum number of characters allowed for an entry slug. Entry collection only. Default: `Infinity`."
682
808
  },
683
809
  "summary": {
684
810
  "type": "string",
685
- "description": "Entry summary template. Entry collection only. Default: `identifier_field`."
811
+ "description": "Entry summary template. Entry collection only. Default: `identifier_field`.",
812
+ "markdownDescription": "Entry summary template. Entry collection only. Default: `identifier_field`."
686
813
  },
687
814
  "sortable_fields": {
688
815
  "anyOf": [
@@ -696,21 +823,24 @@
696
823
  "$ref": "#/definitions/SortableFields"
697
824
  }
698
825
  ],
699
- "description": "Custom sortable fields. Entry collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend, commit author and commit date are also included by default."
826
+ "description": "Custom sortable fields. Entry collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend, commit author and commit date are also included by default. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details.",
827
+ "markdownDescription": "Custom sortable fields. Entry collection only. Default: `title`, `name`, `date`, `author` and `description`. For a Git backend, commit author and commit date are also included by default. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details."
700
828
  },
701
829
  "view_filters": {
702
830
  "type": "array",
703
831
  "items": {
704
832
  "$ref": "#/definitions/ViewFilter"
705
833
  },
706
- "description": "View filters to be used in the entry list. Entry collection only."
834
+ "description": "View filters to be used in the entry list. Entry collection only.",
835
+ "markdownDescription": "View filters to be used in the entry list. Entry collection only."
707
836
  },
708
837
  "view_groups": {
709
838
  "type": "array",
710
839
  "items": {
711
840
  "$ref": "#/definitions/ViewGroup"
712
841
  },
713
- "description": "View groups to be used in the entry list. Entry collection only."
842
+ "description": "View groups to be used in the entry list. Entry collection only.",
843
+ "markdownDescription": "View groups to be used in the entry list. Entry collection only."
714
844
  },
715
845
  "i18n": {
716
846
  "anyOf": [
@@ -721,27 +851,33 @@
721
851
  "type": "boolean"
722
852
  }
723
853
  ],
724
- "description": "I18n options. Default: `false`."
854
+ "description": "I18n options. Default: `false`.",
855
+ "markdownDescription": "I18n options. Default: `false`."
725
856
  },
726
857
  "preview_path": {
727
858
  "type": "string",
728
- "description": "Preview URL path template."
859
+ "description": "Preview URL path template.",
860
+ "markdownDescription": "Preview URL path template."
729
861
  },
730
862
  "preview_path_date_field": {
731
863
  "type": "string",
732
- "description": "Date field name used for `preview_path`."
864
+ "description": "Date field name used for `preview_path`.",
865
+ "markdownDescription": "Date field name used for `preview_path`."
733
866
  },
734
867
  "editor": {
735
868
  "$ref": "#/definitions/EditorOptions",
736
- "description": "Editor view options."
869
+ "description": "Editor view options.",
870
+ "markdownDescription": "Editor view options."
737
871
  },
738
872
  "nested": {
739
873
  "$ref": "#/definitions/NestedCollectionOptions",
740
- "description": "Options for a nested collection. Entry collection only."
874
+ "description": "Options for a nested collection. Entry collection only.",
875
+ "markdownDescription": "Options for a nested collection. Entry collection only."
741
876
  },
742
877
  "meta": {
743
878
  "$ref": "#/definitions/CollectionMetaData",
744
- "description": "Meta data for a nested collection. Entry collection only."
879
+ "description": "Meta data for a nested collection. Entry collection only.",
880
+ "markdownDescription": "Meta data for a nested collection. Entry collection only."
745
881
  },
746
882
  "index_file": {
747
883
  "anyOf": [
@@ -752,11 +888,13 @@
752
888
  "type": "boolean"
753
889
  }
754
890
  ],
755
- "description": "Index file inclusion options. Entry collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s special index file."
891
+ "description": "Index file inclusion options. Entry collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s special index file. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details.",
892
+ "markdownDescription": "Index file inclusion options. Entry collection only. If `true`, the default index file name is `_index`, which is used for Hugo’s special index file. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details."
756
893
  },
757
894
  "yaml_quote": {
758
895
  "type": "boolean",
759
- "description": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options."
896
+ "description": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options.",
897
+ "markdownDescription": "Whether to double-quote all the strings values if the YAML format is used for file output. Default: `false`. DEPRECATED in favor of the global YAML format options."
760
898
  },
761
899
  "thumbnail": {
762
900
  "anyOf": [
@@ -770,60 +908,72 @@
770
908
  }
771
909
  }
772
910
  ],
773
- "description": "A field key path to be used to find an entry thumbnail displayed on the entry list. A nested field can be specified using dot notation, e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of any non-nested, non-empty field using the Image or File widget is used. Entry collection only."
911
+ "description": "A field key path to be used to find an entry thumbnail displayed on the entry list. A nested field can be specified using dot notation, e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of any non-nested, non-empty field using the Image or File widget is used. Entry collection only.",
912
+ "markdownDescription": "A field key path to be used to find an entry thumbnail displayed on the entry list. A nested field can be specified using dot notation, e.g. `heroImage.src`. A wildcard in the key path is also supported, e.g. `images.*.src`. Multiple key paths can be specified as an array for fallbacks. If this option is omitted, the `name` of any non-nested, non-empty field using the Image or File widget is used. Entry collection only."
774
913
  },
775
914
  "limit": {
776
915
  "type": "number",
777
- "description": "The maximum number of entries that can be created in the collection. Entry collection only. Default: `Infinity`."
916
+ "description": "The maximum number of entries that can be created in the collection. Entry collection only. Default: `Infinity`.",
917
+ "markdownDescription": "The maximum number of entries that can be created in the collection. Entry collection only. Default: `Infinity`."
778
918
  }
779
919
  },
780
920
  "required": [
781
921
  "name"
782
922
  ],
783
923
  "additionalProperties": false,
784
- "description": "A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is called an entry collection."
924
+ "description": "A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is called an entry collection.",
925
+ "markdownDescription": "A raw collection defined in the configuration file. Note: In Sveltia CMS, a folder collection is called an entry collection."
785
926
  },
786
927
  "FieldKeyPath": {
787
928
  "type": "string",
788
- "description": "An entry field name. It can be written in dot notation like `author.name` if the field is nested with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We call this a key path, which is derived from the IndexedDB API terminology, and use it everywhere, as entry data is managed as a flatten object for easier access."
929
+ "description": "An entry field name. It can be written in dot notation like `author.name` if the field is nested with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We call this a key path, which is derived from the [IndexedDB API terminology](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#key_path), and use it everywhere, as entry data is managed as a [flatten object](https://www.npmjs.com/package/flat) for easier access.",
930
+ "markdownDescription": "An entry field name. It can be written in dot notation like `author.name` if the field is nested with an Object field. For a List subfield, a wildcard can be used like `authors.*.name`. We call this a key path, which is derived from the [IndexedDB API terminology](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API/Basic_Terminology#key_path), and use it everywhere, as entry data is managed as a [flatten object](https://www.npmjs.com/package/flat) for easier access."
789
931
  },
790
932
  "CollectionFile": {
791
933
  "type": "object",
792
934
  "properties": {
793
935
  "name": {
794
936
  "type": "string",
795
- "description": "Unique identifier for the file."
937
+ "description": "Unique identifier for the file.",
938
+ "markdownDescription": "Unique identifier for the file."
796
939
  },
797
940
  "label": {
798
941
  "type": "string",
799
- "description": "Label to be displayed in the editor UI. Default: `name` option value."
942
+ "description": "Label to be displayed in the editor UI. Default: `name` option value.",
943
+ "markdownDescription": "Label to be displayed in the editor UI. Default: `name` option value."
800
944
  },
801
945
  "icon": {
802
946
  "type": "string",
803
- "description": "Name of a Material Symbols icon to be displayed in the collection file list and other places."
947
+ "description": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection file list and other places. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-icon-for-a-collection) for details.",
948
+ "markdownDescription": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the collection file list and other places. See our [README](https://github.com/sveltia/sveltia-cms#using-a-custom-icon-for-a-collection) for details."
804
949
  },
805
950
  "file": {
806
951
  "type": "string",
807
- "description": "File path relative to the project root."
952
+ "description": "File path relative to the project root.",
953
+ "markdownDescription": "File path relative to the project root."
808
954
  },
809
955
  "fields": {
810
956
  "type": "array",
811
957
  "items": {
812
958
  "$ref": "#/definitions/Field"
813
959
  },
814
- "description": "Set of fields to be included in the file."
960
+ "description": "Set of fields to be included in the file.",
961
+ "markdownDescription": "Set of fields to be included in the file."
815
962
  },
816
963
  "media_folder": {
817
964
  "type": "string",
818
- "description": "Internal media folder path for the collection. This overrides the global or collection-level `media_folder` option."
965
+ "description": "Internal media folder path for the collection. This overrides the global or collection-level `media_folder` option.",
966
+ "markdownDescription": "Internal media folder path for the collection. This overrides the global or collection-level `media_folder` option."
819
967
  },
820
968
  "public_folder": {
821
969
  "type": "string",
822
- "description": "Public media folder path for an entry collection. This overrides the global or collection-level `public_folder` option. Default: `media_folder` option value."
970
+ "description": "Public media folder path for an entry collection. This overrides the global or collection-level `public_folder` option. Default: `media_folder` option value.",
971
+ "markdownDescription": "Public media folder path for an entry collection. This overrides the global or collection-level `public_folder` option. Default: `media_folder` option value."
823
972
  },
824
973
  "format": {
825
974
  "$ref": "#/definitions/FileFormat",
826
- "description": "File format. This overrides the collection-level `format` option. Default: `yaml-frontmatter`."
975
+ "description": "File format. This overrides the collection-level `format` option. Default: `yaml-frontmatter`.",
976
+ "markdownDescription": "File format. This overrides the collection-level `format` option. Default: `yaml-frontmatter`."
827
977
  },
828
978
  "frontmatter_delimiter": {
829
979
  "anyOf": [
@@ -837,7 +987,8 @@
837
987
  }
838
988
  }
839
989
  ],
840
- "description": "Delimiters to be used for the front matter format. This overrides the collection-level `frontmatter_delimiter` option. Default: depends on the front matter type."
990
+ "description": "Delimiters to be used for the front matter format. This overrides the collection-level `frontmatter_delimiter` option. Default: depends on the front matter type.",
991
+ "markdownDescription": "Delimiters to be used for the front matter format. This overrides the collection-level `frontmatter_delimiter` option. Default: depends on the front matter type."
841
992
  },
842
993
  "i18n": {
843
994
  "anyOf": [
@@ -848,15 +999,18 @@
848
999
  "type": "boolean"
849
1000
  }
850
1001
  ],
851
- "description": "I18n options. Default: `false`."
1002
+ "description": "I18n options. Default: `false`.",
1003
+ "markdownDescription": "I18n options. Default: `false`."
852
1004
  },
853
1005
  "preview_path": {
854
1006
  "type": "string",
855
- "description": "Preview URL path template."
1007
+ "description": "Preview URL path template.",
1008
+ "markdownDescription": "Preview URL path template."
856
1009
  },
857
1010
  "preview_path_date_field": {
858
1011
  "$ref": "#/definitions/FieldKeyPath",
859
- "description": "Date field name used for `preview_path`."
1012
+ "description": "Date field name used for `preview_path`.",
1013
+ "markdownDescription": "Date field name used for `preview_path`."
860
1014
  }
861
1015
  },
862
1016
  "required": [
@@ -865,7 +1019,8 @@
865
1019
  "fields"
866
1020
  ],
867
1021
  "additionalProperties": false,
868
- "description": "Single file in a file/singleton collection."
1022
+ "description": "Single file in a file/singleton collection.",
1023
+ "markdownDescription": "Single file in a file/singleton collection."
869
1024
  },
870
1025
  "Field": {
871
1026
  "anyOf": [
@@ -876,7 +1031,8 @@
876
1031
  "$ref": "#/definitions/CustomField"
877
1032
  }
878
1033
  ],
879
- "description": "Entry field."
1034
+ "description": "Entry field.",
1035
+ "markdownDescription": "Entry field."
880
1036
  },
881
1037
  "StandardField": {
882
1038
  "anyOf": [
@@ -938,27 +1094,32 @@
938
1094
  "$ref": "#/definitions/UuidField"
939
1095
  }
940
1096
  ],
941
- "description": "Entry field using a built-in widget."
1097
+ "description": "Entry field using a built-in widget.",
1098
+ "markdownDescription": "Entry field using a built-in widget."
942
1099
  },
943
1100
  "BooleanField": {
944
1101
  "type": "object",
945
1102
  "properties": {
946
1103
  "before_input": {
947
1104
  "type": "string",
948
- "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
1105
+ "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string.",
1106
+ "markdownDescription": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
949
1107
  },
950
1108
  "after_input": {
951
1109
  "type": "string",
952
- "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
1110
+ "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string.",
1111
+ "markdownDescription": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
953
1112
  },
954
1113
  "widget": {
955
1114
  "type": "string",
956
1115
  "const": "boolean",
957
- "description": "Widget name."
1116
+ "description": "Widget name.",
1117
+ "markdownDescription": "Widget name."
958
1118
  },
959
1119
  "default": {
960
1120
  "type": "boolean",
961
- "description": "Default value. Accepts `true` or `false`."
1121
+ "description": "Default value. Accepts `true` or `false`.",
1122
+ "markdownDescription": "Default value. Accepts `true` or `false`."
962
1123
  },
963
1124
  "required": {
964
1125
  "anyOf": [
@@ -972,11 +1133,13 @@
972
1133
  }
973
1134
  }
974
1135
  ],
975
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1136
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1137
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
976
1138
  },
977
1139
  "readonly": {
978
1140
  "type": "boolean",
979
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1141
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1142
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
980
1143
  },
981
1144
  "pattern": {
982
1145
  "type": "array",
@@ -998,27 +1161,33 @@
998
1161
  }
999
1162
  ],
1000
1163
  "maxItems": 2,
1001
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1164
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1165
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1002
1166
  },
1003
1167
  "name": {
1004
1168
  "type": "string",
1005
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1169
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1170
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1006
1171
  },
1007
1172
  "label": {
1008
1173
  "type": "string",
1009
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1174
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1175
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1010
1176
  },
1011
1177
  "comment": {
1012
1178
  "type": "string",
1013
- "description": "Short description of the field to be displayed in the editor UI."
1179
+ "description": "Short description of the field to be displayed in the editor UI.",
1180
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1014
1181
  },
1015
1182
  "hint": {
1016
1183
  "type": "string",
1017
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1184
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1185
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1018
1186
  },
1019
1187
  "preview": {
1020
1188
  "type": "boolean",
1021
- "description": "Whether to show the preview of the field. Default: `true`."
1189
+ "description": "Whether to show the preview of the field. Default: `true`.",
1190
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1022
1191
  },
1023
1192
  "i18n": {
1024
1193
  "anyOf": [
@@ -1038,18 +1207,21 @@
1038
1207
  "const": "none"
1039
1208
  }
1040
1209
  ],
1041
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1210
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1211
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1042
1212
  }
1043
1213
  },
1044
1214
  "required": [
1045
1215
  "name",
1046
1216
  "widget"
1047
1217
  ],
1048
- "description": "Boolean field definition."
1218
+ "description": "Boolean field definition.",
1219
+ "markdownDescription": "Boolean field definition."
1049
1220
  },
1050
1221
  "LocaleCode": {
1051
1222
  "type": "string",
1052
- "description": "Standard IETF locale tag like `en` or `en-US`."
1223
+ "description": "Standard [IETF locale tag](https://en.wikipedia.org/wiki/IETF_language_tag) like `en` or `en-US`.",
1224
+ "markdownDescription": "Standard [IETF locale tag](https://en.wikipedia.org/wiki/IETF_language_tag) like `en` or `en-US`."
1053
1225
  },
1054
1226
  "CodeField": {
1055
1227
  "type": "object",
@@ -1057,7 +1229,8 @@
1057
1229
  "widget": {
1058
1230
  "type": "string",
1059
1231
  "const": "code",
1060
- "description": "Widget name."
1232
+ "description": "Widget name.",
1233
+ "markdownDescription": "Widget name."
1061
1234
  },
1062
1235
  "default": {
1063
1236
  "anyOf": [
@@ -1071,19 +1244,23 @@
1071
1244
  }
1072
1245
  }
1073
1246
  ],
1074
- "description": "Default value. It must be a string if `output_code_only` is `false`. Otherwise it must be an object that match the `keys` option."
1247
+ "description": "Default value. It must be a string if `output_code_only` is `false`. Otherwise it must be an object that match the `keys` option.",
1248
+ "markdownDescription": "Default value. It must be a string if `output_code_only` is `false`. Otherwise it must be an object that match the `keys` option."
1075
1249
  },
1076
1250
  "default_language": {
1077
1251
  "type": "string",
1078
- "description": "Default language to be selected, like `js`. See https://prismjs.com/#supported-languages for a list of supported languages. Default: empty string, which is plaintext."
1252
+ "description": "Default language to be selected, like `js`. See the [Prism documentation](https://prismjs.com/#supported-languages) for a list of supported languages. Default: empty string, which is plaintext.",
1253
+ "markdownDescription": "Default language to be selected, like `js`. See the [Prism documentation](https://prismjs.com/#supported-languages) for a list of supported languages. Default: empty string, which is plaintext."
1079
1254
  },
1080
1255
  "allow_language_selection": {
1081
1256
  "type": "boolean",
1082
- "description": "Whether to show a language switcher so that users can change the language mode. Default: `true` (the Decap CMS document is wrong)."
1257
+ "description": "Whether to show a language switcher so that users can change the language mode. Default: `true` (the Decap CMS document is wrong).",
1258
+ "markdownDescription": "Whether to show a language switcher so that users can change the language mode. Default: `true` (the Decap CMS document is wrong)."
1083
1259
  },
1084
1260
  "output_code_only": {
1085
1261
  "type": "boolean",
1086
- "description": "Whether to output code snippet only. Default: `false`."
1262
+ "description": "Whether to output code snippet only. Default: `false`.",
1263
+ "markdownDescription": "Whether to output code snippet only. Default: `false`."
1087
1264
  },
1088
1265
  "keys": {
1089
1266
  "type": "object",
@@ -1100,7 +1277,8 @@
1100
1277
  "lang"
1101
1278
  ],
1102
1279
  "additionalProperties": false,
1103
- "description": "Output property names. It has no effect if `output_code_only` is `true`. Default: `{ code: 'code', lang: 'lang' }`."
1280
+ "description": "Output property names. It has no effect if `output_code_only` is `true`. Default: `{ code: 'code', lang: 'lang' }`.",
1281
+ "markdownDescription": "Output property names. It has no effect if `output_code_only` is `true`. Default: `{ code: 'code', lang: 'lang' }`."
1104
1282
  },
1105
1283
  "required": {
1106
1284
  "anyOf": [
@@ -1114,11 +1292,13 @@
1114
1292
  }
1115
1293
  }
1116
1294
  ],
1117
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1295
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1296
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1118
1297
  },
1119
1298
  "readonly": {
1120
1299
  "type": "boolean",
1121
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1300
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1301
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1122
1302
  },
1123
1303
  "pattern": {
1124
1304
  "type": "array",
@@ -1140,27 +1320,33 @@
1140
1320
  }
1141
1321
  ],
1142
1322
  "maxItems": 2,
1143
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1323
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1324
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1144
1325
  },
1145
1326
  "name": {
1146
1327
  "type": "string",
1147
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1328
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1329
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1148
1330
  },
1149
1331
  "label": {
1150
1332
  "type": "string",
1151
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1333
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1334
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1152
1335
  },
1153
1336
  "comment": {
1154
1337
  "type": "string",
1155
- "description": "Short description of the field to be displayed in the editor UI."
1338
+ "description": "Short description of the field to be displayed in the editor UI.",
1339
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1156
1340
  },
1157
1341
  "hint": {
1158
1342
  "type": "string",
1159
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1343
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1344
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1160
1345
  },
1161
1346
  "preview": {
1162
1347
  "type": "boolean",
1163
- "description": "Whether to show the preview of the field. Default: `true`."
1348
+ "description": "Whether to show the preview of the field. Default: `true`.",
1349
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1164
1350
  },
1165
1351
  "i18n": {
1166
1352
  "anyOf": [
@@ -1180,14 +1366,16 @@
1180
1366
  "const": "none"
1181
1367
  }
1182
1368
  ],
1183
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1369
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1370
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1184
1371
  }
1185
1372
  },
1186
1373
  "required": [
1187
1374
  "name",
1188
1375
  "widget"
1189
1376
  ],
1190
- "description": "Code field definition."
1377
+ "description": "Code field definition.",
1378
+ "markdownDescription": "Code field definition."
1191
1379
  },
1192
1380
  "ColorField": {
1193
1381
  "type": "object",
@@ -1195,19 +1383,23 @@
1195
1383
  "widget": {
1196
1384
  "type": "string",
1197
1385
  "const": "color",
1198
- "description": "Widget name."
1386
+ "description": "Widget name.",
1387
+ "markdownDescription": "Widget name."
1199
1388
  },
1200
1389
  "default": {
1201
1390
  "type": "string",
1202
- "description": "Default value. Accepts a Hex color code in the six-value (`#RRGGBB`) or eight-value (`#RRGGBBAA`) syntax."
1391
+ "description": "Default value. Accepts a Hex color code in the six-value (`#RRGGBB`) or eight-value (`#RRGGBBAA`) syntax.",
1392
+ "markdownDescription": "Default value. Accepts a Hex color code in the six-value (`#RRGGBB`) or eight-value (`#RRGGBBAA`) syntax."
1203
1393
  },
1204
1394
  "allowInput": {
1205
1395
  "type": "boolean",
1206
- "description": "Whether to show a textbox that allows users to manually edit the value. Default: `false`."
1396
+ "description": "Whether to show a textbox that allows users to manually edit the value. Default: `false`.",
1397
+ "markdownDescription": "Whether to show a textbox that allows users to manually edit the value. Default: `false`."
1207
1398
  },
1208
1399
  "enableAlpha": {
1209
1400
  "type": "boolean",
1210
- "description": "Whether to edit/save the alpha channel value. Default: `false`."
1401
+ "description": "Whether to edit/save the alpha channel value. Default: `false`.",
1402
+ "markdownDescription": "Whether to edit/save the alpha channel value. Default: `false`."
1211
1403
  },
1212
1404
  "required": {
1213
1405
  "anyOf": [
@@ -1221,11 +1413,13 @@
1221
1413
  }
1222
1414
  }
1223
1415
  ],
1224
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1416
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1417
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1225
1418
  },
1226
1419
  "readonly": {
1227
1420
  "type": "boolean",
1228
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1421
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1422
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1229
1423
  },
1230
1424
  "pattern": {
1231
1425
  "type": "array",
@@ -1247,27 +1441,33 @@
1247
1441
  }
1248
1442
  ],
1249
1443
  "maxItems": 2,
1250
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1444
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1445
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1251
1446
  },
1252
1447
  "name": {
1253
1448
  "type": "string",
1254
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1449
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1450
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1255
1451
  },
1256
1452
  "label": {
1257
1453
  "type": "string",
1258
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1454
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1455
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1259
1456
  },
1260
1457
  "comment": {
1261
1458
  "type": "string",
1262
- "description": "Short description of the field to be displayed in the editor UI."
1459
+ "description": "Short description of the field to be displayed in the editor UI.",
1460
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1263
1461
  },
1264
1462
  "hint": {
1265
1463
  "type": "string",
1266
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1464
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1465
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1267
1466
  },
1268
1467
  "preview": {
1269
1468
  "type": "boolean",
1270
- "description": "Whether to show the preview of the field. Default: `true`."
1469
+ "description": "Whether to show the preview of the field. Default: `true`.",
1470
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1271
1471
  },
1272
1472
  "i18n": {
1273
1473
  "anyOf": [
@@ -1287,14 +1487,16 @@
1287
1487
  "const": "none"
1288
1488
  }
1289
1489
  ],
1290
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1490
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1491
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1291
1492
  }
1292
1493
  },
1293
1494
  "required": [
1294
1495
  "name",
1295
1496
  "widget"
1296
1497
  ],
1297
- "description": "Color field definition."
1498
+ "description": "Color field definition.",
1499
+ "markdownDescription": "Color field definition."
1298
1500
  },
1299
1501
  "ComputeField": {
1300
1502
  "type": "object",
@@ -1302,11 +1504,13 @@
1302
1504
  "widget": {
1303
1505
  "type": "string",
1304
1506
  "const": "compute",
1305
- "description": "Widget name."
1507
+ "description": "Widget name.",
1508
+ "markdownDescription": "Widget name."
1306
1509
  },
1307
1510
  "value": {
1308
1511
  "type": "string",
1309
- "description": "Value template, like `posts-{{fields.slug}}`."
1512
+ "description": "Value template, like `posts-{{fields.slug}}`.",
1513
+ "markdownDescription": "Value template, like `posts-{{fields.slug}}`."
1310
1514
  },
1311
1515
  "required": {
1312
1516
  "anyOf": [
@@ -1320,11 +1524,13 @@
1320
1524
  }
1321
1525
  }
1322
1526
  ],
1323
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1527
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1528
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1324
1529
  },
1325
1530
  "readonly": {
1326
1531
  "type": "boolean",
1327
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1532
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1533
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1328
1534
  },
1329
1535
  "pattern": {
1330
1536
  "type": "array",
@@ -1346,27 +1552,33 @@
1346
1552
  }
1347
1553
  ],
1348
1554
  "maxItems": 2,
1349
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1555
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1556
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1350
1557
  },
1351
1558
  "name": {
1352
1559
  "type": "string",
1353
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1560
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1561
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1354
1562
  },
1355
1563
  "label": {
1356
1564
  "type": "string",
1357
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1565
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1566
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1358
1567
  },
1359
1568
  "comment": {
1360
1569
  "type": "string",
1361
- "description": "Short description of the field to be displayed in the editor UI."
1570
+ "description": "Short description of the field to be displayed in the editor UI.",
1571
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1362
1572
  },
1363
1573
  "hint": {
1364
1574
  "type": "string",
1365
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1575
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1576
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1366
1577
  },
1367
1578
  "preview": {
1368
1579
  "type": "boolean",
1369
- "description": "Whether to show the preview of the field. Default: `true`."
1580
+ "description": "Whether to show the preview of the field. Default: `true`.",
1581
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1370
1582
  },
1371
1583
  "i18n": {
1372
1584
  "anyOf": [
@@ -1386,7 +1598,8 @@
1386
1598
  "const": "none"
1387
1599
  }
1388
1600
  ],
1389
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1601
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1602
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1390
1603
  }
1391
1604
  },
1392
1605
  "required": [
@@ -1394,7 +1607,8 @@
1394
1607
  "value",
1395
1608
  "widget"
1396
1609
  ],
1397
- "description": "Compute field definition."
1610
+ "description": "Compute field definition.",
1611
+ "markdownDescription": "Compute field definition."
1398
1612
  },
1399
1613
  "DateTimeField": {
1400
1614
  "type": "object",
@@ -1402,33 +1616,39 @@
1402
1616
  "widget": {
1403
1617
  "type": "string",
1404
1618
  "const": "datetime",
1405
- "description": "Widget name."
1619
+ "description": "Widget name.",
1620
+ "markdownDescription": "Widget name."
1406
1621
  },
1407
1622
  "default": {
1408
1623
  "type": "string",
1409
- "description": "Default value. Accepts a date/time string that matches the `format`, or `{{now}}` to populate the current date/time. Default: empty string."
1624
+ "description": "Default value. Accepts a date/time string that matches the `format`, or `{{now}}` to populate the current date/time. Default: empty string.",
1625
+ "markdownDescription": "Default value. Accepts a date/time string that matches the `format`, or `{{now}}` to populate the current date/time. Default: empty string."
1410
1626
  },
1411
1627
  "format": {
1412
1628
  "type": "string",
1413
- "description": "Storage format written in Moment.js tokens. See https://momentjs.com/docs/#/displaying/format/ for supported tokens. Default: ISO 8601 format."
1629
+ "description": "Storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/). Default: ISO 8601 format.",
1630
+ "markdownDescription": "Storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/). Default: ISO 8601 format."
1414
1631
  },
1415
1632
  "date_format": {
1416
1633
  "type": [
1417
1634
  "string",
1418
1635
  "boolean"
1419
1636
  ],
1420
- "description": "Date storage format written in Moment.js tokens if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, date input/output is disabled."
1637
+ "description": "Date storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, date input/output is disabled.",
1638
+ "markdownDescription": "Date storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, date input/output is disabled."
1421
1639
  },
1422
1640
  "time_format": {
1423
1641
  "type": [
1424
1642
  "string",
1425
1643
  "boolean"
1426
1644
  ],
1427
- "description": "Time storage format written in Moment.js tokens if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, time input/output is disabled."
1645
+ "description": "Time storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, time input/output is disabled.",
1646
+ "markdownDescription": "Time storage format written in [Moment.js tokens](https://momentjs.com/docs/#/displaying/format/) if the value is a string and the `format` option is not defined. If `true`, ISO 8601 format is used unless the `format` option is defined. If `false`, time input/output is disabled."
1428
1647
  },
1429
1648
  "picker_utc": {
1430
1649
  "type": "boolean",
1431
- "description": "Whether to make the date input/output UTC. Default: `false`."
1650
+ "description": "Whether to make the date input/output UTC. Default: `false`.",
1651
+ "markdownDescription": "Whether to make the date input/output UTC. Default: `false`."
1432
1652
  },
1433
1653
  "required": {
1434
1654
  "anyOf": [
@@ -1442,11 +1662,13 @@
1442
1662
  }
1443
1663
  }
1444
1664
  ],
1445
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1665
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1666
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1446
1667
  },
1447
1668
  "readonly": {
1448
1669
  "type": "boolean",
1449
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1670
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1671
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1450
1672
  },
1451
1673
  "pattern": {
1452
1674
  "type": "array",
@@ -1468,27 +1690,33 @@
1468
1690
  }
1469
1691
  ],
1470
1692
  "maxItems": 2,
1471
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1693
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1694
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1472
1695
  },
1473
1696
  "name": {
1474
1697
  "type": "string",
1475
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1698
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1699
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1476
1700
  },
1477
1701
  "label": {
1478
1702
  "type": "string",
1479
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1703
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1704
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1480
1705
  },
1481
1706
  "comment": {
1482
1707
  "type": "string",
1483
- "description": "Short description of the field to be displayed in the editor UI."
1708
+ "description": "Short description of the field to be displayed in the editor UI.",
1709
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1484
1710
  },
1485
1711
  "hint": {
1486
1712
  "type": "string",
1487
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1713
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1714
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1488
1715
  },
1489
1716
  "preview": {
1490
1717
  "type": "boolean",
1491
- "description": "Whether to show the preview of the field. Default: `true`."
1718
+ "description": "Whether to show the preview of the field. Default: `true`.",
1719
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1492
1720
  },
1493
1721
  "i18n": {
1494
1722
  "anyOf": [
@@ -1508,14 +1736,16 @@
1508
1736
  "const": "none"
1509
1737
  }
1510
1738
  ],
1511
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1739
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1740
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1512
1741
  }
1513
1742
  },
1514
1743
  "required": [
1515
1744
  "name",
1516
1745
  "widget"
1517
1746
  ],
1518
- "description": "DateTime field definition."
1747
+ "description": "DateTime field definition.",
1748
+ "markdownDescription": "DateTime field definition."
1519
1749
  },
1520
1750
  "FileField": {
1521
1751
  "type": "object",
@@ -1523,27 +1753,33 @@
1523
1753
  "widget": {
1524
1754
  "type": "string",
1525
1755
  "const": "file",
1526
- "description": "Widget name."
1756
+ "description": "Widget name.",
1757
+ "markdownDescription": "Widget name."
1527
1758
  },
1528
1759
  "default": {
1529
1760
  "type": "string",
1530
- "description": "Default value. Accepts a file path or complete URL."
1761
+ "description": "Default value. Accepts a file path or complete URL.",
1762
+ "markdownDescription": "Default value. Accepts a file path or complete URL."
1531
1763
  },
1532
1764
  "accept": {
1533
1765
  "type": "string",
1534
- "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML `accept` attribute: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept."
1766
+ "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute.",
1767
+ "markdownDescription": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute."
1535
1768
  },
1536
1769
  "choose_url": {
1537
1770
  "type": "boolean",
1538
- "description": "Whether to show the URL input UI. Default: `true`."
1771
+ "description": "Whether to show the URL input UI. Default: `true`.",
1772
+ "markdownDescription": "Whether to show the URL input UI. Default: `true`."
1539
1773
  },
1540
1774
  "media_folder": {
1541
1775
  "type": "string",
1542
- "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
1776
+ "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value.",
1777
+ "markdownDescription": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
1543
1778
  },
1544
1779
  "public_folder": {
1545
1780
  "type": "string",
1546
- "description": "Public media folder path for the field. Default: `media_folder` option value."
1781
+ "description": "Public media folder path for the field. Default: `media_folder` option value.",
1782
+ "markdownDescription": "Public media folder path for the field. Default: `media_folder` option value."
1547
1783
  },
1548
1784
  "media_library": {
1549
1785
  "anyOf": [
@@ -1553,11 +1789,13 @@
1553
1789
  "properties": {
1554
1790
  "name": {
1555
1791
  "$ref": "#/definitions/MediaLibraryName",
1556
- "description": "Library name."
1792
+ "description": "Library name.",
1793
+ "markdownDescription": "Library name."
1557
1794
  },
1558
1795
  "config": {
1559
1796
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
1560
- "description": "Configuration for the default media library."
1797
+ "description": "Configuration for the default media library.",
1798
+ "markdownDescription": "Configuration for the default media library."
1561
1799
  }
1562
1800
  }
1563
1801
  },
@@ -1567,23 +1805,28 @@
1567
1805
  "properties": {
1568
1806
  "name": {
1569
1807
  "$ref": "#/definitions/MediaLibraryName",
1570
- "description": "Library name."
1808
+ "description": "Library name.",
1809
+ "markdownDescription": "Library name."
1571
1810
  },
1572
1811
  "output_filename_only": {
1573
1812
  "type": "boolean",
1574
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
1813
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
1814
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
1575
1815
  },
1576
1816
  "use_transformations": {
1577
1817
  "type": "boolean",
1578
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
1818
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
1819
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
1579
1820
  },
1580
1821
  "use_secure_url": {
1581
1822
  "type": "boolean",
1582
- "description": "Whether to use an HTTP URL. Default: `true`."
1823
+ "description": "Whether to use an HTTP URL. Default: `true`.",
1824
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
1583
1825
  },
1584
1826
  "config": {
1585
1827
  "type": "object",
1586
- "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
1828
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
1829
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
1587
1830
  }
1588
1831
  }
1589
1832
  },
@@ -1593,15 +1836,18 @@
1593
1836
  "properties": {
1594
1837
  "name": {
1595
1838
  "$ref": "#/definitions/MediaLibraryName",
1596
- "description": "Library name."
1839
+ "description": "Library name.",
1840
+ "markdownDescription": "Library name."
1597
1841
  },
1598
1842
  "config": {
1599
1843
  "type": "object",
1600
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
1844
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
1845
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
1601
1846
  },
1602
1847
  "settings": {
1603
1848
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
1604
- "description": "Integration settings."
1849
+ "description": "Integration settings.",
1850
+ "markdownDescription": "Integration settings."
1605
1851
  }
1606
1852
  }
1607
1853
  },
@@ -1611,27 +1857,32 @@
1611
1857
  "properties": {
1612
1858
  "name": {
1613
1859
  "$ref": "#/definitions/MediaLibraryName",
1614
- "description": "Library name."
1860
+ "description": "Library name.",
1861
+ "markdownDescription": "Library name."
1615
1862
  },
1616
1863
  "providers": {
1617
1864
  "type": "array",
1618
1865
  "items": {
1619
1866
  "$ref": "#/definitions/StockAssetProviderName"
1620
1867
  },
1621
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
1868
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
1869
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
1622
1870
  }
1623
1871
  }
1624
1872
  }
1625
1873
  ],
1626
- "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
1874
+ "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries.",
1875
+ "markdownDescription": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
1627
1876
  },
1628
1877
  "media_libraries": {
1629
1878
  "$ref": "#/definitions/MediaLibraries",
1630
- "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
1879
+ "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option.",
1880
+ "markdownDescription": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
1631
1881
  },
1632
1882
  "allow_multiple": {
1633
1883
  "type": "boolean",
1634
- "description": "Whether to enable multiple item selection in an external media library. Default: `true`."
1884
+ "description": "Whether to enable multiple item selection in an external media library. Default: `true`.",
1885
+ "markdownDescription": "Whether to enable multiple item selection in an external media library. Default: `true`."
1635
1886
  },
1636
1887
  "required": {
1637
1888
  "anyOf": [
@@ -1645,11 +1896,13 @@
1645
1896
  }
1646
1897
  }
1647
1898
  ],
1648
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1899
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
1900
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1649
1901
  },
1650
1902
  "readonly": {
1651
1903
  "type": "boolean",
1652
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1904
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
1905
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1653
1906
  },
1654
1907
  "pattern": {
1655
1908
  "type": "array",
@@ -1671,27 +1924,33 @@
1671
1924
  }
1672
1925
  ],
1673
1926
  "maxItems": 2,
1674
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1927
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
1928
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1675
1929
  },
1676
1930
  "name": {
1677
1931
  "type": "string",
1678
- "description": "Unique identifier for the field. It cannot include periods and spaces."
1932
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
1933
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1679
1934
  },
1680
1935
  "label": {
1681
1936
  "type": "string",
1682
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1937
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
1938
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1683
1939
  },
1684
1940
  "comment": {
1685
1941
  "type": "string",
1686
- "description": "Short description of the field to be displayed in the editor UI."
1942
+ "description": "Short description of the field to be displayed in the editor UI.",
1943
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1687
1944
  },
1688
1945
  "hint": {
1689
1946
  "type": "string",
1690
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1947
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
1948
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1691
1949
  },
1692
1950
  "preview": {
1693
1951
  "type": "boolean",
1694
- "description": "Whether to show the preview of the field. Default: `true`."
1952
+ "description": "Whether to show the preview of the field. Default: `true`.",
1953
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1695
1954
  },
1696
1955
  "i18n": {
1697
1956
  "anyOf": [
@@ -1711,14 +1970,16 @@
1711
1970
  "const": "none"
1712
1971
  }
1713
1972
  ],
1714
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1973
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
1974
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1715
1975
  }
1716
1976
  },
1717
1977
  "required": [
1718
1978
  "name",
1719
1979
  "widget"
1720
1980
  ],
1721
- "description": "File field definition."
1981
+ "description": "File field definition.",
1982
+ "markdownDescription": "File field definition."
1722
1983
  },
1723
1984
  "HiddenField": {
1724
1985
  "type": "object",
@@ -1726,10 +1987,12 @@
1726
1987
  "widget": {
1727
1988
  "type": "string",
1728
1989
  "const": "hidden",
1729
- "description": "Widget name."
1990
+ "description": "Widget name.",
1991
+ "markdownDescription": "Widget name."
1730
1992
  },
1731
1993
  "default": {
1732
- "description": "Default value. Accepts any data type that can be stored with the configured file format."
1994
+ "description": "Default value. Accepts any data type that can be stored with the configured file format.",
1995
+ "markdownDescription": "Default value. Accepts any data type that can be stored with the configured file format."
1733
1996
  },
1734
1997
  "required": {
1735
1998
  "anyOf": [
@@ -1743,11 +2006,13 @@
1743
2006
  }
1744
2007
  }
1745
2008
  ],
1746
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2009
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2010
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1747
2011
  },
1748
2012
  "readonly": {
1749
2013
  "type": "boolean",
1750
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2014
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2015
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1751
2016
  },
1752
2017
  "pattern": {
1753
2018
  "type": "array",
@@ -1769,27 +2034,33 @@
1769
2034
  }
1770
2035
  ],
1771
2036
  "maxItems": 2,
1772
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2037
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2038
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1773
2039
  },
1774
2040
  "name": {
1775
2041
  "type": "string",
1776
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2042
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2043
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1777
2044
  },
1778
2045
  "label": {
1779
2046
  "type": "string",
1780
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2047
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2048
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1781
2049
  },
1782
2050
  "comment": {
1783
2051
  "type": "string",
1784
- "description": "Short description of the field to be displayed in the editor UI."
2052
+ "description": "Short description of the field to be displayed in the editor UI.",
2053
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1785
2054
  },
1786
2055
  "hint": {
1787
2056
  "type": "string",
1788
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2057
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2058
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1789
2059
  },
1790
2060
  "preview": {
1791
2061
  "type": "boolean",
1792
- "description": "Whether to show the preview of the field. Default: `true`."
2062
+ "description": "Whether to show the preview of the field. Default: `true`.",
2063
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1793
2064
  },
1794
2065
  "i18n": {
1795
2066
  "anyOf": [
@@ -1809,14 +2080,16 @@
1809
2080
  "const": "none"
1810
2081
  }
1811
2082
  ],
1812
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2083
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2084
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
1813
2085
  }
1814
2086
  },
1815
2087
  "required": [
1816
2088
  "name",
1817
2089
  "widget"
1818
2090
  ],
1819
- "description": "Hidden field definition."
2091
+ "description": "Hidden field definition.",
2092
+ "markdownDescription": "Hidden field definition."
1820
2093
  },
1821
2094
  "ImageField": {
1822
2095
  "type": "object",
@@ -1824,27 +2097,33 @@
1824
2097
  "widget": {
1825
2098
  "type": "string",
1826
2099
  "const": "image",
1827
- "description": "Widget name."
2100
+ "description": "Widget name.",
2101
+ "markdownDescription": "Widget name."
1828
2102
  },
1829
2103
  "default": {
1830
2104
  "type": "string",
1831
- "description": "Default value. Accepts a file path or complete URL."
2105
+ "description": "Default value. Accepts a file path or complete URL.",
2106
+ "markdownDescription": "Default value. Accepts a file path or complete URL."
1832
2107
  },
1833
2108
  "accept": {
1834
2109
  "type": "string",
1835
- "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML `accept` attribute: https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept."
2110
+ "description": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute.",
2111
+ "markdownDescription": "File types that the field should accept. The value would be a comma-separated list of unique file type specifiers, the format used for the HTML [`accept`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/accept) attribute."
1836
2112
  },
1837
2113
  "choose_url": {
1838
2114
  "type": "boolean",
1839
- "description": "Whether to show the URL input UI. Default: `true`."
2115
+ "description": "Whether to show the URL input UI. Default: `true`.",
2116
+ "markdownDescription": "Whether to show the URL input UI. Default: `true`."
1840
2117
  },
1841
2118
  "media_folder": {
1842
2119
  "type": "string",
1843
- "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
2120
+ "description": "Internal media folder path for the field. Default: global or collection-level `media_folder` value.",
2121
+ "markdownDescription": "Internal media folder path for the field. Default: global or collection-level `media_folder` value."
1844
2122
  },
1845
2123
  "public_folder": {
1846
2124
  "type": "string",
1847
- "description": "Public media folder path for the field. Default: `media_folder` option value."
2125
+ "description": "Public media folder path for the field. Default: `media_folder` option value.",
2126
+ "markdownDescription": "Public media folder path for the field. Default: `media_folder` option value."
1848
2127
  },
1849
2128
  "media_library": {
1850
2129
  "anyOf": [
@@ -1854,11 +2133,13 @@
1854
2133
  "properties": {
1855
2134
  "name": {
1856
2135
  "$ref": "#/definitions/MediaLibraryName",
1857
- "description": "Library name."
2136
+ "description": "Library name.",
2137
+ "markdownDescription": "Library name."
1858
2138
  },
1859
2139
  "config": {
1860
2140
  "$ref": "#/definitions/DefaultMediaLibraryConfig",
1861
- "description": "Configuration for the default media library."
2141
+ "description": "Configuration for the default media library.",
2142
+ "markdownDescription": "Configuration for the default media library."
1862
2143
  }
1863
2144
  }
1864
2145
  },
@@ -1868,23 +2149,28 @@
1868
2149
  "properties": {
1869
2150
  "name": {
1870
2151
  "$ref": "#/definitions/MediaLibraryName",
1871
- "description": "Library name."
2152
+ "description": "Library name.",
2153
+ "markdownDescription": "Library name."
1872
2154
  },
1873
2155
  "output_filename_only": {
1874
2156
  "type": "boolean",
1875
- "description": "Whether to output a file name instead of a full URL. Default: `false`."
2157
+ "description": "Whether to output a file name instead of a full URL. Default: `false`.",
2158
+ "markdownDescription": "Whether to output a file name instead of a full URL. Default: `false`."
1876
2159
  },
1877
2160
  "use_transformations": {
1878
2161
  "type": "boolean",
1879
- "description": "Whether to include transformation segments in an output URL. Default: `true`."
2162
+ "description": "Whether to include transformation segments in an output URL. Default: `true`.",
2163
+ "markdownDescription": "Whether to include transformation segments in an output URL. Default: `true`."
1880
2164
  },
1881
2165
  "use_secure_url": {
1882
2166
  "type": "boolean",
1883
- "description": "Whether to use an HTTP URL. Default: `true`."
2167
+ "description": "Whether to use an HTTP URL. Default: `true`.",
2168
+ "markdownDescription": "Whether to use an HTTP URL. Default: `true`."
1884
2169
  },
1885
2170
  "config": {
1886
2171
  "type": "object",
1887
- "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options for a full list of available options."
2172
+ "description": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options.",
2173
+ "markdownDescription": "Options to be passed to Cloudinary, such as `multiple`. The `cloud_name` and `api_key` options are required for the global `media_library` option. See the [Cloudinary documentation](https://cloudinary.com/documentation/media_library_widget#2_set_the_configuration_options) for a full list of available options."
1888
2174
  }
1889
2175
  }
1890
2176
  },
@@ -1894,15 +2180,18 @@
1894
2180
  "properties": {
1895
2181
  "name": {
1896
2182
  "$ref": "#/definitions/MediaLibraryName",
1897
- "description": "Library name."
2183
+ "description": "Library name.",
2184
+ "markdownDescription": "Library name."
1898
2185
  },
1899
2186
  "config": {
1900
2187
  "type": "object",
1901
- "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See https://uploadcare.com/docs/uploads/file-uploader-options/ for a full list of available options."
2188
+ "description": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options.",
2189
+ "markdownDescription": "Options to be passed to Uploadcare, such as `multiple`. The `publicKey` option is required for the global `media_library` option. See the [Uploadcare documentation](https://uploadcare.com/docs/uploads/file-uploader-options/) for a full list of available options."
1902
2190
  },
1903
2191
  "settings": {
1904
2192
  "$ref": "#/definitions/UploadcareMediaLibrarySettings",
1905
- "description": "Integration settings."
2193
+ "description": "Integration settings.",
2194
+ "markdownDescription": "Integration settings."
1906
2195
  }
1907
2196
  }
1908
2197
  },
@@ -1912,27 +2201,32 @@
1912
2201
  "properties": {
1913
2202
  "name": {
1914
2203
  "$ref": "#/definitions/MediaLibraryName",
1915
- "description": "Library name."
2204
+ "description": "Library name.",
2205
+ "markdownDescription": "Library name."
1916
2206
  },
1917
2207
  "providers": {
1918
2208
  "type": "array",
1919
2209
  "items": {
1920
2210
  "$ref": "#/definitions/StockAssetProviderName"
1921
2211
  },
1922
- "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
2212
+ "description": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers.",
2213
+ "markdownDescription": "Enabled stock photo/video providers. The stock photo/video section in the asset browser is hidden if an empty array is given. Default: all supported providers."
1923
2214
  }
1924
2215
  }
1925
2216
  }
1926
2217
  ],
1927
- "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
2218
+ "description": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries.",
2219
+ "markdownDescription": "Legacy media library option that allows only one library. This overrides the global `media_library` option. Use `media_libraries` instead to support multiple libraries."
1928
2220
  },
1929
2221
  "media_libraries": {
1930
2222
  "$ref": "#/definitions/MediaLibraries",
1931
- "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
2223
+ "description": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option.",
2224
+ "markdownDescription": "Unified media library option that supports multiple libraries. This overrides the global `media_libraries` option."
1932
2225
  },
1933
2226
  "allow_multiple": {
1934
2227
  "type": "boolean",
1935
- "description": "Whether to enable multiple item selection in an external media library. Default: `true`."
2228
+ "description": "Whether to enable multiple item selection in an external media library. Default: `true`.",
2229
+ "markdownDescription": "Whether to enable multiple item selection in an external media library. Default: `true`."
1936
2230
  },
1937
2231
  "required": {
1938
2232
  "anyOf": [
@@ -1946,11 +2240,13 @@
1946
2240
  }
1947
2241
  }
1948
2242
  ],
1949
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2243
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2244
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
1950
2245
  },
1951
2246
  "readonly": {
1952
2247
  "type": "boolean",
1953
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2248
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2249
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
1954
2250
  },
1955
2251
  "pattern": {
1956
2252
  "type": "array",
@@ -1972,27 +2268,33 @@
1972
2268
  }
1973
2269
  ],
1974
2270
  "maxItems": 2,
1975
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2271
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2272
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
1976
2273
  },
1977
2274
  "name": {
1978
2275
  "type": "string",
1979
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2276
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2277
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
1980
2278
  },
1981
2279
  "label": {
1982
2280
  "type": "string",
1983
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2281
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2282
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
1984
2283
  },
1985
2284
  "comment": {
1986
2285
  "type": "string",
1987
- "description": "Short description of the field to be displayed in the editor UI."
2286
+ "description": "Short description of the field to be displayed in the editor UI.",
2287
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
1988
2288
  },
1989
2289
  "hint": {
1990
2290
  "type": "string",
1991
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2291
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2292
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
1992
2293
  },
1993
2294
  "preview": {
1994
2295
  "type": "boolean",
1995
- "description": "Whether to show the preview of the field. Default: `true`."
2296
+ "description": "Whether to show the preview of the field. Default: `true`.",
2297
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
1996
2298
  },
1997
2299
  "i18n": {
1998
2300
  "anyOf": [
@@ -2012,45 +2314,53 @@
2012
2314
  "const": "none"
2013
2315
  }
2014
2316
  ],
2015
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2317
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2318
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2016
2319
  }
2017
2320
  },
2018
2321
  "required": [
2019
2322
  "name",
2020
2323
  "widget"
2021
2324
  ],
2022
- "description": "Image field definition."
2325
+ "description": "Image field definition.",
2326
+ "markdownDescription": "Image field definition."
2023
2327
  },
2024
2328
  "KeyValueField": {
2025
2329
  "type": "object",
2026
2330
  "properties": {
2027
2331
  "min": {
2028
2332
  "type": "number",
2029
- "description": "Minimum number of items that can be added. Default: `0`."
2333
+ "description": "Minimum number of items that can be added. Default: `0`.",
2334
+ "markdownDescription": "Minimum number of items that can be added. Default: `0`."
2030
2335
  },
2031
2336
  "max": {
2032
2337
  "type": "number",
2033
- "description": "Maximum number of items that can be added. Default: `Infinity`."
2338
+ "description": "Maximum number of items that can be added. Default: `Infinity`.",
2339
+ "markdownDescription": "Maximum number of items that can be added. Default: `Infinity`."
2034
2340
  },
2035
2341
  "widget": {
2036
2342
  "type": "string",
2037
2343
  "const": "keyvalue",
2038
- "description": "Widget name."
2344
+ "description": "Widget name.",
2345
+ "markdownDescription": "Widget name."
2039
2346
  },
2040
2347
  "default": {
2041
2348
  "type": "object",
2042
2349
  "additionalProperties": {
2043
2350
  "type": "string"
2044
2351
  },
2045
- "description": "Default key-value pairs."
2352
+ "description": "Default key-value pairs.",
2353
+ "markdownDescription": "Default key-value pairs."
2046
2354
  },
2047
2355
  "key_label": {
2048
2356
  "type": "string",
2049
- "description": "Label for the key column. Default: Key."
2357
+ "description": "Label for the key column. Default: Key.",
2358
+ "markdownDescription": "Label for the key column. Default: Key."
2050
2359
  },
2051
2360
  "value_label": {
2052
2361
  "type": "string",
2053
- "description": "Label for the value column. Default: Value."
2362
+ "description": "Label for the value column. Default: Value.",
2363
+ "markdownDescription": "Label for the value column. Default: Value."
2054
2364
  },
2055
2365
  "required": {
2056
2366
  "anyOf": [
@@ -2064,11 +2374,13 @@
2064
2374
  }
2065
2375
  }
2066
2376
  ],
2067
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2377
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2378
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2068
2379
  },
2069
2380
  "readonly": {
2070
2381
  "type": "boolean",
2071
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2382
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2383
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2072
2384
  },
2073
2385
  "pattern": {
2074
2386
  "type": "array",
@@ -2090,27 +2402,33 @@
2090
2402
  }
2091
2403
  ],
2092
2404
  "maxItems": 2,
2093
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2405
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2406
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2094
2407
  },
2095
2408
  "name": {
2096
2409
  "type": "string",
2097
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2410
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2411
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2098
2412
  },
2099
2413
  "label": {
2100
2414
  "type": "string",
2101
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2415
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2416
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2102
2417
  },
2103
2418
  "comment": {
2104
2419
  "type": "string",
2105
- "description": "Short description of the field to be displayed in the editor UI."
2420
+ "description": "Short description of the field to be displayed in the editor UI.",
2421
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2106
2422
  },
2107
2423
  "hint": {
2108
2424
  "type": "string",
2109
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2425
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2426
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2110
2427
  },
2111
2428
  "preview": {
2112
2429
  "type": "boolean",
2113
- "description": "Whether to show the preview of the field. Default: `true`."
2430
+ "description": "Whether to show the preview of the field. Default: `true`.",
2431
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2114
2432
  },
2115
2433
  "i18n": {
2116
2434
  "anyOf": [
@@ -2130,14 +2448,16 @@
2130
2448
  "const": "none"
2131
2449
  }
2132
2450
  ],
2133
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2451
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2452
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2134
2453
  }
2135
2454
  },
2136
2455
  "required": [
2137
2456
  "name",
2138
2457
  "widget"
2139
2458
  ],
2140
- "description": "KeyValue field definition."
2459
+ "description": "KeyValue field definition.",
2460
+ "markdownDescription": "KeyValue field definition."
2141
2461
  },
2142
2462
  "ListField": {
2143
2463
  "type": "object",
@@ -2147,24 +2467,29 @@
2147
2467
  "items": {
2148
2468
  "$ref": "#/definitions/VariableFieldType"
2149
2469
  },
2150
- "description": "Set of nested Object fields to be selected or added."
2470
+ "description": "Set of nested Object fields to be selected or added.",
2471
+ "markdownDescription": "Set of nested Object fields to be selected or added."
2151
2472
  },
2152
2473
  "typeKey": {
2153
2474
  "type": "string",
2154
- "description": "Property name to store the type name in nested objects. Default: `type`."
2475
+ "description": "Property name to store the type name in nested objects. Default: `type`.",
2476
+ "markdownDescription": "Property name to store the type name in nested objects. Default: `type`."
2155
2477
  },
2156
2478
  "min": {
2157
2479
  "type": "number",
2158
- "description": "Minimum number of items that can be added. Default: `0`."
2480
+ "description": "Minimum number of items that can be added. Default: `0`.",
2481
+ "markdownDescription": "Minimum number of items that can be added. Default: `0`."
2159
2482
  },
2160
2483
  "max": {
2161
2484
  "type": "number",
2162
- "description": "Maximum number of items that can be added. Default: `Infinity`."
2485
+ "description": "Maximum number of items that can be added. Default: `Infinity`.",
2486
+ "markdownDescription": "Maximum number of items that can be added. Default: `Infinity`."
2163
2487
  },
2164
2488
  "widget": {
2165
2489
  "type": "string",
2166
2490
  "const": "list",
2167
- "description": "Widget name."
2491
+ "description": "Widget name.",
2492
+ "markdownDescription": "Widget name."
2168
2493
  },
2169
2494
  "default": {
2170
2495
  "anyOf": [
@@ -2184,23 +2509,28 @@
2184
2509
  "type": "object"
2185
2510
  }
2186
2511
  ],
2187
- "description": "Default value. The format depends on how the field is configured, with or without `field`, `fields` or `types`. See the document for details."
2512
+ "description": "Default value. The format depends on how the field is configured, with or without `field`, `fields` or `types`. See the document for details.",
2513
+ "markdownDescription": "Default value. The format depends on how the field is configured, with or without `field`, `fields` or `types`. See the document for details."
2188
2514
  },
2189
2515
  "allow_add": {
2190
2516
  "type": "boolean",
2191
- "description": "Whether to allow users to add new values. Default: `true`."
2517
+ "description": "Whether to allow users to add new values. Default: `true`.",
2518
+ "markdownDescription": "Whether to allow users to add new values. Default: `true`."
2192
2519
  },
2193
2520
  "add_to_top": {
2194
2521
  "type": "boolean",
2195
- "description": "Whether to add new items to the top of the list instead of the bottom. Default: `false`."
2522
+ "description": "Whether to add new items to the top of the list instead of the bottom. Default: `false`.",
2523
+ "markdownDescription": "Whether to add new items to the top of the list instead of the bottom. Default: `false`."
2196
2524
  },
2197
2525
  "label_singular": {
2198
2526
  "type": "string",
2199
- "description": "Label to be displayed on the Add button. Default: `label` field value."
2527
+ "description": "Label to be displayed on the Add button. Default: `label` field value.",
2528
+ "markdownDescription": "Label to be displayed on the Add button. Default: `label` field value."
2200
2529
  },
2201
2530
  "summary": {
2202
2531
  "type": "string",
2203
- "description": "Template of a label to be displayed on a collapsed list item."
2532
+ "description": "Template of a label to be displayed on a collapsed list item.",
2533
+ "markdownDescription": "Template of a label to be displayed on a collapsed list item."
2204
2534
  },
2205
2535
  "collapsed": {
2206
2536
  "anyOf": [
@@ -2212,7 +2542,8 @@
2212
2542
  "const": "auto"
2213
2543
  }
2214
2544
  ],
2215
- "description": "Whether to collapse the list items by default. Default: `false`. If set to `auto`, the UI is collapsed if the item has any filled subfields and expanded if all the subfields are empty."
2545
+ "description": "Whether to collapse the list items by default. Default: `false`. If set to `auto`, the UI is collapsed if the item has any filled subfields and expanded if all the subfields are empty.",
2546
+ "markdownDescription": "Whether to collapse the list items by default. Default: `false`. If set to `auto`, the UI is collapsed if the item has any filled subfields and expanded if all the subfields are empty."
2216
2547
  },
2217
2548
  "minimize_collapsed": {
2218
2549
  "anyOf": [
@@ -2224,22 +2555,26 @@
2224
2555
  "const": "auto"
2225
2556
  }
2226
2557
  ],
2227
- "description": "Whether to collapse the entire list. Default: `false`. If set to `auto`, the UI is collapsed if the list has any items and expanded if it’s empty."
2558
+ "description": "Whether to collapse the entire list. Default: `false`. If set to `auto`, the UI is collapsed if the list has any items and expanded if it’s empty.",
2559
+ "markdownDescription": "Whether to collapse the entire list. Default: `false`. If set to `auto`, the UI is collapsed if the list has any items and expanded if it’s empty."
2228
2560
  },
2229
2561
  "field": {
2230
2562
  "$ref": "#/definitions/Field",
2231
- "description": "Single field to be included in a list item."
2563
+ "description": "Single field to be included in a list item.",
2564
+ "markdownDescription": "Single field to be included in a list item."
2232
2565
  },
2233
2566
  "fields": {
2234
2567
  "type": "array",
2235
2568
  "items": {
2236
2569
  "$ref": "#/definitions/Field"
2237
2570
  },
2238
- "description": "Set of fields to be included in a list item."
2571
+ "description": "Set of fields to be included in a list item.",
2572
+ "markdownDescription": "Set of fields to be included in a list item."
2239
2573
  },
2240
2574
  "root": {
2241
2575
  "type": "boolean",
2242
- "description": "Whether to save the field value at the top-level of the data file without the field name. If the `single_file` i18n structure is enabled, the lists will still be saved under locale keys. Default: `false`. See https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list for details."
2576
+ "description": "Whether to save the field value at the top-level of the data file without the field name. If the `single_file` i18n structure is enabled, the lists will still be saved under locale keys. Default: `false`. See our [README](https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list) for details.",
2577
+ "markdownDescription": "Whether to save the field value at the top-level of the data file without the field name. If the `single_file` i18n structure is enabled, the lists will still be saved under locale keys. Default: `false`. See our [README](https://github.com/sveltia/sveltia-cms#editing-data-files-with-a-top-level-list) for details."
2243
2578
  },
2244
2579
  "required": {
2245
2580
  "anyOf": [
@@ -2253,11 +2588,13 @@
2253
2588
  }
2254
2589
  }
2255
2590
  ],
2256
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2591
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2592
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2257
2593
  },
2258
2594
  "readonly": {
2259
2595
  "type": "boolean",
2260
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2596
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2597
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2261
2598
  },
2262
2599
  "pattern": {
2263
2600
  "type": "array",
@@ -2279,27 +2616,33 @@
2279
2616
  }
2280
2617
  ],
2281
2618
  "maxItems": 2,
2282
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2619
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2620
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2283
2621
  },
2284
2622
  "name": {
2285
2623
  "type": "string",
2286
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2624
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2625
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2287
2626
  },
2288
2627
  "label": {
2289
2628
  "type": "string",
2290
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2629
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2630
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2291
2631
  },
2292
2632
  "comment": {
2293
2633
  "type": "string",
2294
- "description": "Short description of the field to be displayed in the editor UI."
2634
+ "description": "Short description of the field to be displayed in the editor UI.",
2635
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2295
2636
  },
2296
2637
  "hint": {
2297
2638
  "type": "string",
2298
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2639
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2640
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2299
2641
  },
2300
2642
  "preview": {
2301
2643
  "type": "boolean",
2302
- "description": "Whether to show the preview of the field. Default: `true`."
2644
+ "description": "Whether to show the preview of the field. Default: `true`.",
2645
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2303
2646
  },
2304
2647
  "i18n": {
2305
2648
  "anyOf": [
@@ -2319,48 +2662,56 @@
2319
2662
  "const": "none"
2320
2663
  }
2321
2664
  ],
2322
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2665
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2666
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2323
2667
  }
2324
2668
  },
2325
2669
  "required": [
2326
2670
  "name",
2327
2671
  "widget"
2328
2672
  ],
2329
- "description": "List field definition."
2673
+ "description": "List field definition.",
2674
+ "markdownDescription": "List field definition."
2330
2675
  },
2331
2676
  "VariableFieldType": {
2332
2677
  "type": "object",
2333
2678
  "properties": {
2334
2679
  "name": {
2335
2680
  "type": "string",
2336
- "description": "Unique identifier for the type."
2681
+ "description": "Unique identifier for the type.",
2682
+ "markdownDescription": "Unique identifier for the type."
2337
2683
  },
2338
2684
  "label": {
2339
2685
  "type": "string",
2340
- "description": "Label of the type to be displayed in the editor UI. Default: `name` field value."
2686
+ "description": "Label of the type to be displayed in the editor UI. Default: `name` field value.",
2687
+ "markdownDescription": "Label of the type to be displayed in the editor UI. Default: `name` field value."
2341
2688
  },
2342
2689
  "widget": {
2343
2690
  "type": "string",
2344
2691
  "const": "object",
2345
- "description": "Widget name. Values other than `object` are ignored."
2692
+ "description": "Widget name. Values other than `object` are ignored.",
2693
+ "markdownDescription": "Widget name. Values other than `object` are ignored."
2346
2694
  },
2347
2695
  "summary": {
2348
2696
  "type": "string",
2349
- "description": "Template of a label to be displayed on a collapsed object."
2697
+ "description": "Template of a label to be displayed on a collapsed object.",
2698
+ "markdownDescription": "Template of a label to be displayed on a collapsed object."
2350
2699
  },
2351
2700
  "fields": {
2352
2701
  "type": "array",
2353
2702
  "items": {
2354
2703
  "$ref": "#/definitions/Field"
2355
2704
  },
2356
- "description": "Set of subfields. This option can be omitted; in that case, only the `type` property will be saved."
2705
+ "description": "Set of subfields. This option can be omitted; in that case, only the `type` property will be saved.",
2706
+ "markdownDescription": "Set of subfields. This option can be omitted; in that case, only the `type` property will be saved."
2357
2707
  }
2358
2708
  },
2359
2709
  "required": [
2360
2710
  "name"
2361
2711
  ],
2362
2712
  "additionalProperties": false,
2363
- "description": "Variable type for List/Object fields."
2713
+ "description": "Variable type for List/Object fields.",
2714
+ "markdownDescription": "Variable type for List/Object fields."
2364
2715
  },
2365
2716
  "MapField": {
2366
2717
  "type": "object",
@@ -2368,15 +2719,18 @@
2368
2719
  "widget": {
2369
2720
  "type": "string",
2370
2721
  "const": "map",
2371
- "description": "Widget name."
2722
+ "description": "Widget name.",
2723
+ "markdownDescription": "Widget name."
2372
2724
  },
2373
2725
  "default": {
2374
2726
  "type": "string",
2375
- "description": "Default value. Accepts a stringified single GeoJSON geometry object that contains `type` and `coordinates` properties."
2727
+ "description": "Default value. Accepts a stringified single [GeoJSON](https://geojson.org/) geometry object that contains `type` and `coordinates` properties.",
2728
+ "markdownDescription": "Default value. Accepts a stringified single [GeoJSON](https://geojson.org/) geometry object that contains `type` and `coordinates` properties."
2376
2729
  },
2377
2730
  "decimals": {
2378
2731
  "type": "number",
2379
- "description": "Precision of coordinates to be saved. Default: `7`."
2732
+ "description": "Precision of coordinates to be saved. Default: `7`.",
2733
+ "markdownDescription": "Precision of coordinates to be saved. Default: `7`."
2380
2734
  },
2381
2735
  "type": {
2382
2736
  "type": "string",
@@ -2385,7 +2739,8 @@
2385
2739
  "LineString",
2386
2740
  "Polygon"
2387
2741
  ],
2388
- "description": "Geometry type. Default: `Point`."
2742
+ "description": "Geometry type. Default: `Point`.",
2743
+ "markdownDescription": "Geometry type. Default: `Point`."
2389
2744
  },
2390
2745
  "required": {
2391
2746
  "anyOf": [
@@ -2399,11 +2754,13 @@
2399
2754
  }
2400
2755
  }
2401
2756
  ],
2402
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2757
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2758
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2403
2759
  },
2404
2760
  "readonly": {
2405
2761
  "type": "boolean",
2406
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2762
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2763
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2407
2764
  },
2408
2765
  "pattern": {
2409
2766
  "type": "array",
@@ -2425,27 +2782,33 @@
2425
2782
  }
2426
2783
  ],
2427
2784
  "maxItems": 2,
2428
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2785
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2786
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2429
2787
  },
2430
2788
  "name": {
2431
2789
  "type": "string",
2432
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2790
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2791
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2433
2792
  },
2434
2793
  "label": {
2435
2794
  "type": "string",
2436
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2795
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2796
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2437
2797
  },
2438
2798
  "comment": {
2439
2799
  "type": "string",
2440
- "description": "Short description of the field to be displayed in the editor UI."
2800
+ "description": "Short description of the field to be displayed in the editor UI.",
2801
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2441
2802
  },
2442
2803
  "hint": {
2443
2804
  "type": "string",
2444
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2805
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2806
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2445
2807
  },
2446
2808
  "preview": {
2447
2809
  "type": "boolean",
2448
- "description": "Whether to show the preview of the field. Default: `true`."
2810
+ "description": "Whether to show the preview of the field. Default: `true`.",
2811
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2449
2812
  },
2450
2813
  "i18n": {
2451
2814
  "anyOf": [
@@ -2465,14 +2828,16 @@
2465
2828
  "const": "none"
2466
2829
  }
2467
2830
  ],
2468
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2831
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2832
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2469
2833
  }
2470
2834
  },
2471
2835
  "required": [
2472
2836
  "name",
2473
2837
  "widget"
2474
2838
  ],
2475
- "description": "Map field definition."
2839
+ "description": "Map field definition.",
2840
+ "markdownDescription": "Map field definition."
2476
2841
  },
2477
2842
  "MarkdownField": {
2478
2843
  "type": "object",
@@ -2480,22 +2845,26 @@
2480
2845
  "widget": {
2481
2846
  "type": "string",
2482
2847
  "const": "markdown",
2483
- "description": "Widget name."
2848
+ "description": "Widget name.",
2849
+ "markdownDescription": "Widget name."
2484
2850
  },
2485
2851
  "default": {
2486
2852
  "type": "string",
2487
- "description": "Default value."
2853
+ "description": "Default value.",
2854
+ "markdownDescription": "Default value."
2488
2855
  },
2489
2856
  "minimal": {
2490
2857
  "type": "boolean",
2491
- "description": "Whether to minimize the toolbar height."
2858
+ "description": "Whether to minimize the toolbar height.",
2859
+ "markdownDescription": "Whether to minimize the toolbar height."
2492
2860
  },
2493
2861
  "buttons": {
2494
2862
  "type": "array",
2495
2863
  "items": {
2496
2864
  "$ref": "#/definitions/RichTextEditorButtonName"
2497
2865
  },
2498
- "description": "Names of formatting buttons and menu items to be enabled in the editor UI. Default: all the supported button names."
2866
+ "description": "Names of formatting buttons and menu items to be enabled in the editor UI. Default: all the supported button names.",
2867
+ "markdownDescription": "Names of formatting buttons and menu items to be enabled in the editor UI. Default: all the supported button names."
2499
2868
  },
2500
2869
  "editor_components": {
2501
2870
  "type": "array",
@@ -2509,22 +2878,26 @@
2509
2878
  }
2510
2879
  ]
2511
2880
  },
2512
- "description": "Names of components to be enabled in the editor UI. This may include custom component names. Default: all the built-in component names."
2881
+ "description": "Names of components to be enabled in the editor UI. This may include custom component names. Default: all the built-in component names.",
2882
+ "markdownDescription": "Names of components to be enabled in the editor UI. This may include custom component names. Default: all the built-in component names."
2513
2883
  },
2514
2884
  "modes": {
2515
2885
  "type": "array",
2516
2886
  "items": {
2517
2887
  "$ref": "#/definitions/RichTextEditorMode"
2518
2888
  },
2519
- "description": "Editor modes to be enabled. If it’s `[raw, rich_text]`, rich text mode is disabled by default. Default: `[rich_text, raw]`."
2889
+ "description": "Editor modes to be enabled. If it’s `[raw, rich_text]`, rich text mode is disabled by default. Default: `[rich_text, raw]`.",
2890
+ "markdownDescription": "Editor modes to be enabled. If it’s `[raw, rich_text]`, rich text mode is disabled by default. Default: `[rich_text, raw]`."
2520
2891
  },
2521
2892
  "sanitize_preview": {
2522
2893
  "type": "boolean",
2523
- "description": "Whether to sanitize the preview HTML. Default: `false`."
2894
+ "description": "Whether to sanitize the preview HTML. Default: `false`.",
2895
+ "markdownDescription": "Whether to sanitize the preview HTML. Default: `false`."
2524
2896
  },
2525
2897
  "linked_images": {
2526
2898
  "type": "boolean",
2527
- "description": "Whether to enable the linked images feature for the built-in `image` component. Default: `true`. When enabled, the image component provides an additional text field for specifying a URL to wrap the image as a link. The resulting Markdown output will be in the format `[![alt](src)](link)`, where clicking the image navigates to the provided link. This feature can be disabled if it causes conflicts with certain frameworks."
2899
+ "description": "Whether to enable the linked images feature for the built-in `image` component. Default: `true`. When enabled, the image component provides an additional text field for specifying a URL to wrap the image as a link. The resulting Markdown output will be in the format `[![alt](src)](link)`, where clicking the image navigates to the provided link. This feature can be disabled if it causes conflicts with certain frameworks.",
2900
+ "markdownDescription": "Whether to enable the linked images feature for the built-in `image` component. Default: `true`. When enabled, the image component provides an additional text field for specifying a URL to wrap the image as a link. The resulting Markdown output will be in the format `[![alt](src)](link)`, where clicking the image navigates to the provided link. This feature can be disabled if it causes conflicts with certain frameworks."
2528
2901
  },
2529
2902
  "required": {
2530
2903
  "anyOf": [
@@ -2538,11 +2911,13 @@
2538
2911
  }
2539
2912
  }
2540
2913
  ],
2541
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2914
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
2915
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2542
2916
  },
2543
2917
  "readonly": {
2544
2918
  "type": "boolean",
2545
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2919
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
2920
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2546
2921
  },
2547
2922
  "pattern": {
2548
2923
  "type": "array",
@@ -2564,27 +2939,33 @@
2564
2939
  }
2565
2940
  ],
2566
2941
  "maxItems": 2,
2567
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2942
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
2943
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2568
2944
  },
2569
2945
  "name": {
2570
2946
  "type": "string",
2571
- "description": "Unique identifier for the field. It cannot include periods and spaces."
2947
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
2948
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2572
2949
  },
2573
2950
  "label": {
2574
2951
  "type": "string",
2575
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2952
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
2953
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2576
2954
  },
2577
2955
  "comment": {
2578
2956
  "type": "string",
2579
- "description": "Short description of the field to be displayed in the editor UI."
2957
+ "description": "Short description of the field to be displayed in the editor UI.",
2958
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2580
2959
  },
2581
2960
  "hint": {
2582
2961
  "type": "string",
2583
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2962
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
2963
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2584
2964
  },
2585
2965
  "preview": {
2586
2966
  "type": "boolean",
2587
- "description": "Whether to show the preview of the field. Default: `true`."
2967
+ "description": "Whether to show the preview of the field. Default: `true`.",
2968
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2588
2969
  },
2589
2970
  "i18n": {
2590
2971
  "anyOf": [
@@ -2604,14 +2985,16 @@
2604
2985
  "const": "none"
2605
2986
  }
2606
2987
  ],
2607
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2988
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
2989
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2608
2990
  }
2609
2991
  },
2610
2992
  "required": [
2611
2993
  "name",
2612
2994
  "widget"
2613
2995
  ],
2614
- "description": "Markdown field definition."
2996
+ "description": "Markdown field definition.",
2997
+ "markdownDescription": "Markdown field definition."
2615
2998
  },
2616
2999
  "RichTextEditorButtonName": {
2617
3000
  "type": "string",
@@ -2630,7 +3013,8 @@
2630
3013
  "bulleted-list",
2631
3014
  "numbered-list"
2632
3015
  ],
2633
- "description": "Supported button name for the rich text editor."
3016
+ "description": "Supported button name for the rich text editor.",
3017
+ "markdownDescription": "Supported button name for the rich text editor."
2634
3018
  },
2635
3019
  "RichTextEditorComponentName": {
2636
3020
  "type": "string",
@@ -2638,7 +3022,8 @@
2638
3022
  "code-block",
2639
3023
  "image"
2640
3024
  ],
2641
- "description": "Built-in editor component name for the rich text editor."
3025
+ "description": "Built-in editor component name for the rich text editor.",
3026
+ "markdownDescription": "Built-in editor component name for the rich text editor."
2642
3027
  },
2643
3028
  "RichTextEditorMode": {
2644
3029
  "type": "string",
@@ -2646,46 +3031,55 @@
2646
3031
  "rich_text",
2647
3032
  "raw"
2648
3033
  ],
2649
- "description": "Supported mode name for the rich text editor."
3034
+ "description": "Supported mode name for the rich text editor.",
3035
+ "markdownDescription": "Supported mode name for the rich text editor."
2650
3036
  },
2651
3037
  "NumberField": {
2652
3038
  "type": "object",
2653
3039
  "properties": {
2654
3040
  "before_input": {
2655
3041
  "type": "string",
2656
- "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
3042
+ "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string.",
3043
+ "markdownDescription": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
2657
3044
  },
2658
3045
  "after_input": {
2659
3046
  "type": "string",
2660
- "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
3047
+ "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string.",
3048
+ "markdownDescription": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
2661
3049
  },
2662
3050
  "widget": {
2663
3051
  "type": "string",
2664
3052
  "const": "number",
2665
- "description": "Widget name."
3053
+ "description": "Widget name.",
3054
+ "markdownDescription": "Widget name."
2666
3055
  },
2667
3056
  "default": {
2668
3057
  "type": [
2669
3058
  "number",
2670
3059
  "string"
2671
3060
  ],
2672
- "description": "Default value."
3061
+ "description": "Default value.",
3062
+ "markdownDescription": "Default value."
2673
3063
  },
2674
3064
  "value_type": {
2675
3065
  "type": "string",
2676
- "description": "Type of value to be saved. Default: `int`."
3066
+ "description": "Type of value to be saved. Default: `int`.",
3067
+ "markdownDescription": "Type of value to be saved. Default: `int`."
2677
3068
  },
2678
3069
  "min": {
2679
3070
  "type": "number",
2680
- "description": "Minimum value that can be entered in the input. Default: `-Infinity`."
3071
+ "description": "Minimum value that can be entered in the input. Default: `-Infinity`.",
3072
+ "markdownDescription": "Minimum value that can be entered in the input. Default: `-Infinity`."
2681
3073
  },
2682
3074
  "max": {
2683
3075
  "type": "number",
2684
- "description": "Maximum value that can be entered in the input. Default: `Infinity`."
3076
+ "description": "Maximum value that can be entered in the input. Default: `Infinity`.",
3077
+ "markdownDescription": "Maximum value that can be entered in the input. Default: `Infinity`."
2685
3078
  },
2686
3079
  "step": {
2687
3080
  "type": "number",
2688
- "description": "Number to increase/decrease with the arrow key/button. Default: `1`."
3081
+ "description": "Number to increase/decrease with the arrow key/button. Default: `1`.",
3082
+ "markdownDescription": "Number to increase/decrease with the arrow key/button. Default: `1`."
2689
3083
  },
2690
3084
  "required": {
2691
3085
  "anyOf": [
@@ -2699,11 +3093,13 @@
2699
3093
  }
2700
3094
  }
2701
3095
  ],
2702
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3096
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3097
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2703
3098
  },
2704
3099
  "readonly": {
2705
3100
  "type": "boolean",
2706
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3101
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3102
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2707
3103
  },
2708
3104
  "pattern": {
2709
3105
  "type": "array",
@@ -2725,27 +3121,33 @@
2725
3121
  }
2726
3122
  ],
2727
3123
  "maxItems": 2,
2728
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3124
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3125
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2729
3126
  },
2730
3127
  "name": {
2731
3128
  "type": "string",
2732
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3129
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3130
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2733
3131
  },
2734
3132
  "label": {
2735
3133
  "type": "string",
2736
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3134
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3135
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2737
3136
  },
2738
3137
  "comment": {
2739
3138
  "type": "string",
2740
- "description": "Short description of the field to be displayed in the editor UI."
3139
+ "description": "Short description of the field to be displayed in the editor UI.",
3140
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2741
3141
  },
2742
3142
  "hint": {
2743
3143
  "type": "string",
2744
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3144
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3145
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2745
3146
  },
2746
3147
  "preview": {
2747
3148
  "type": "boolean",
2748
- "description": "Whether to show the preview of the field. Default: `true`."
3149
+ "description": "Whether to show the preview of the field. Default: `true`.",
3150
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2749
3151
  },
2750
3152
  "i18n": {
2751
3153
  "anyOf": [
@@ -2765,14 +3167,16 @@
2765
3167
  "const": "none"
2766
3168
  }
2767
3169
  ],
2768
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3170
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3171
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2769
3172
  }
2770
3173
  },
2771
3174
  "required": [
2772
3175
  "name",
2773
3176
  "widget"
2774
3177
  ],
2775
- "description": "Number field definition."
3178
+ "description": "Number field definition.",
3179
+ "markdownDescription": "Number field definition."
2776
3180
  },
2777
3181
  "ObjectField": {
2778
3182
  "type": "object",
@@ -2782,20 +3186,24 @@
2782
3186
  "items": {
2783
3187
  "$ref": "#/definitions/VariableFieldType"
2784
3188
  },
2785
- "description": "Set of nested Object fields to be selected or added."
3189
+ "description": "Set of nested Object fields to be selected or added.",
3190
+ "markdownDescription": "Set of nested Object fields to be selected or added."
2786
3191
  },
2787
3192
  "typeKey": {
2788
3193
  "type": "string",
2789
- "description": "Property name to store the type name in nested objects. Default: `type`."
3194
+ "description": "Property name to store the type name in nested objects. Default: `type`.",
3195
+ "markdownDescription": "Property name to store the type name in nested objects. Default: `type`."
2790
3196
  },
2791
3197
  "widget": {
2792
3198
  "type": "string",
2793
3199
  "const": "object",
2794
- "description": "Widget name."
3200
+ "description": "Widget name.",
3201
+ "markdownDescription": "Widget name."
2795
3202
  },
2796
3203
  "default": {
2797
3204
  "type": "object",
2798
- "description": "Default values."
3205
+ "description": "Default values.",
3206
+ "markdownDescription": "Default values."
2799
3207
  },
2800
3208
  "collapsed": {
2801
3209
  "anyOf": [
@@ -2807,18 +3215,21 @@
2807
3215
  "const": "auto"
2808
3216
  }
2809
3217
  ],
2810
- "description": "Whether to collapse the object by default. Default: `false`. If set to `auto`, the UI is collapsed if the object has any filled subfields and expanded if all the subfields are empty."
3218
+ "description": "Whether to collapse the object by default. Default: `false`. If set to `auto`, the UI is collapsed if the object has any filled subfields and expanded if all the subfields are empty.",
3219
+ "markdownDescription": "Whether to collapse the object by default. Default: `false`. If set to `auto`, the UI is collapsed if the object has any filled subfields and expanded if all the subfields are empty."
2811
3220
  },
2812
3221
  "summary": {
2813
3222
  "type": "string",
2814
- "description": "Template of a label to be displayed on a collapsed object."
3223
+ "description": "Template of a label to be displayed on a collapsed object.",
3224
+ "markdownDescription": "Template of a label to be displayed on a collapsed object."
2815
3225
  },
2816
3226
  "fields": {
2817
3227
  "type": "array",
2818
3228
  "items": {
2819
3229
  "$ref": "#/definitions/Field"
2820
3230
  },
2821
- "description": "Set of fields to be included."
3231
+ "description": "Set of fields to be included.",
3232
+ "markdownDescription": "Set of fields to be included."
2822
3233
  },
2823
3234
  "required": {
2824
3235
  "anyOf": [
@@ -2832,11 +3243,13 @@
2832
3243
  }
2833
3244
  }
2834
3245
  ],
2835
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3246
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3247
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
2836
3248
  },
2837
3249
  "readonly": {
2838
3250
  "type": "boolean",
2839
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3251
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3252
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
2840
3253
  },
2841
3254
  "pattern": {
2842
3255
  "type": "array",
@@ -2858,27 +3271,33 @@
2858
3271
  }
2859
3272
  ],
2860
3273
  "maxItems": 2,
2861
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3274
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3275
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
2862
3276
  },
2863
3277
  "name": {
2864
3278
  "type": "string",
2865
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3279
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3280
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
2866
3281
  },
2867
3282
  "label": {
2868
3283
  "type": "string",
2869
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3284
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3285
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
2870
3286
  },
2871
3287
  "comment": {
2872
3288
  "type": "string",
2873
- "description": "Short description of the field to be displayed in the editor UI."
3289
+ "description": "Short description of the field to be displayed in the editor UI.",
3290
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
2874
3291
  },
2875
3292
  "hint": {
2876
3293
  "type": "string",
2877
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3294
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3295
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
2878
3296
  },
2879
3297
  "preview": {
2880
3298
  "type": "boolean",
2881
- "description": "Whether to show the preview of the field. Default: `true`."
3299
+ "description": "Whether to show the preview of the field. Default: `true`.",
3300
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
2882
3301
  },
2883
3302
  "i18n": {
2884
3303
  "anyOf": [
@@ -2898,7 +3317,8 @@
2898
3317
  "const": "none"
2899
3318
  }
2900
3319
  ],
2901
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3320
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3321
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
2902
3322
  }
2903
3323
  },
2904
3324
  "required": [
@@ -2906,31 +3326,37 @@
2906
3326
  "name",
2907
3327
  "widget"
2908
3328
  ],
2909
- "description": "Object field definition."
3329
+ "description": "Object field definition.",
3330
+ "markdownDescription": "Object field definition."
2910
3331
  },
2911
3332
  "RelationField": {
2912
3333
  "type": "object",
2913
3334
  "properties": {
2914
3335
  "multiple": {
2915
3336
  "type": "boolean",
2916
- "description": "Whether to accept multiple values. Default: `false`."
3337
+ "description": "Whether to accept multiple values. Default: `false`.",
3338
+ "markdownDescription": "Whether to accept multiple values. Default: `false`."
2917
3339
  },
2918
3340
  "min": {
2919
3341
  "type": "number",
2920
- "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`."
3342
+ "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`.",
3343
+ "markdownDescription": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`."
2921
3344
  },
2922
3345
  "max": {
2923
3346
  "type": "number",
2924
- "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`."
3347
+ "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`.",
3348
+ "markdownDescription": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`."
2925
3349
  },
2926
3350
  "dropdown_threshold": {
2927
3351
  "type": "number",
2928
- "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`."
3352
+ "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`.",
3353
+ "markdownDescription": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`."
2929
3354
  },
2930
3355
  "widget": {
2931
3356
  "type": "string",
2932
3357
  "const": "relation",
2933
- "description": "Widget name."
3358
+ "description": "Widget name.",
3359
+ "markdownDescription": "Widget name."
2934
3360
  },
2935
3361
  "default": {
2936
3362
  "anyOf": [
@@ -2940,15 +3366,18 @@
2940
3366
  "items": {}
2941
3367
  }
2942
3368
  ],
2943
- "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value_field` option."
3369
+ "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value_field` option.",
3370
+ "markdownDescription": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value_field` option."
2944
3371
  },
2945
3372
  "collection": {
2946
3373
  "type": "string",
2947
- "description": "Referenced collection name. Use `_singletons` for the singleton collection."
3374
+ "description": "Referenced collection name. Use `_singletons` for the singleton collection.",
3375
+ "markdownDescription": "Referenced collection name. Use `_singletons` for the singleton collection."
2948
3376
  },
2949
3377
  "file": {
2950
3378
  "type": "string",
2951
- "description": "Referenced file identifier for a file/singleton collection. Required if the `collection` is defined."
3379
+ "description": "Referenced file identifier for a file/singleton collection. Required if the `collection` is defined.",
3380
+ "markdownDescription": "Referenced file identifier for a file/singleton collection. Required if the `collection` is defined."
2952
3381
  },
2953
3382
  "value_field": {
2954
3383
  "anyOf": [
@@ -2959,7 +3388,8 @@
2959
3388
  "type": "string"
2960
3389
  }
2961
3390
  ],
2962
- "description": "Field name to be stored as the value, or `{{slug}}` (entry slug). It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is enabled. Default: `{{slug}}`."
3391
+ "description": "Field name to be stored as the value, or `{{slug}}` (entry slug). It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is enabled. Default: `{{slug}}`.",
3392
+ "markdownDescription": "Field name to be stored as the value, or `{{slug}}` (entry slug). It can contain a locale prefix like `{{locale}}/{{slug}}` if i18n is enabled. Default: `{{slug}}`."
2963
3393
  },
2964
3394
  "display_fields": {
2965
3395
  "type": "array",
@@ -2973,21 +3403,24 @@
2973
3403
  }
2974
3404
  ]
2975
3405
  },
2976
- "description": "Name of fields to be displayed. It can contain string templates. Default: `value_field` field value or the referenced collection’s `identifier_field`, which is `title` by default."
3406
+ "description": "Name of fields to be displayed. It can contain string templates. Default: `value_field` field value or the referenced collection’s `identifier_field`, which is `title` by default.",
3407
+ "markdownDescription": "Name of fields to be displayed. It can contain string templates. Default: `value_field` field value or the referenced collection’s `identifier_field`, which is `title` by default."
2977
3408
  },
2978
3409
  "search_fields": {
2979
3410
  "type": "array",
2980
3411
  "items": {
2981
3412
  "$ref": "#/definitions/FieldKeyPath"
2982
3413
  },
2983
- "description": "Name of fields to be searched. Default: `display_fields` field value."
3414
+ "description": "Name of fields to be searched. Default: `display_fields` field value.",
3415
+ "markdownDescription": "Name of fields to be searched. Default: `display_fields` field value."
2984
3416
  },
2985
3417
  "filters": {
2986
3418
  "type": "array",
2987
3419
  "items": {
2988
3420
  "$ref": "#/definitions/RelationFieldFilterOptions"
2989
3421
  },
2990
- "description": "Entry filter options."
3422
+ "description": "Entry filter options.",
3423
+ "markdownDescription": "Entry filter options."
2991
3424
  },
2992
3425
  "required": {
2993
3426
  "anyOf": [
@@ -3001,11 +3434,13 @@
3001
3434
  }
3002
3435
  }
3003
3436
  ],
3004
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3437
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3438
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3005
3439
  },
3006
3440
  "readonly": {
3007
3441
  "type": "boolean",
3008
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3442
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3443
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3009
3444
  },
3010
3445
  "pattern": {
3011
3446
  "type": "array",
@@ -3027,27 +3462,33 @@
3027
3462
  }
3028
3463
  ],
3029
3464
  "maxItems": 2,
3030
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3465
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3466
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3031
3467
  },
3032
3468
  "name": {
3033
3469
  "type": "string",
3034
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3470
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3471
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3035
3472
  },
3036
3473
  "label": {
3037
3474
  "type": "string",
3038
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3475
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3476
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3039
3477
  },
3040
3478
  "comment": {
3041
3479
  "type": "string",
3042
- "description": "Short description of the field to be displayed in the editor UI."
3480
+ "description": "Short description of the field to be displayed in the editor UI.",
3481
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3043
3482
  },
3044
3483
  "hint": {
3045
3484
  "type": "string",
3046
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3485
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3486
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3047
3487
  },
3048
3488
  "preview": {
3049
3489
  "type": "boolean",
3050
- "description": "Whether to show the preview of the field. Default: `true`."
3490
+ "description": "Whether to show the preview of the field. Default: `true`.",
3491
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3051
3492
  },
3052
3493
  "i18n": {
3053
3494
  "anyOf": [
@@ -3067,7 +3508,8 @@
3067
3508
  "const": "none"
3068
3509
  }
3069
3510
  ],
3070
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3511
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3512
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3071
3513
  }
3072
3514
  },
3073
3515
  "required": [
@@ -3075,19 +3517,22 @@
3075
3517
  "name",
3076
3518
  "widget"
3077
3519
  ],
3078
- "description": "Relation field definition."
3520
+ "description": "Relation field definition.",
3521
+ "markdownDescription": "Relation field definition."
3079
3522
  },
3080
3523
  "RelationFieldFilterOptions": {
3081
3524
  "type": "object",
3082
3525
  "properties": {
3083
3526
  "field": {
3084
3527
  "$ref": "#/definitions/FieldKeyPath",
3085
- "description": "Field name."
3528
+ "description": "Field name.",
3529
+ "markdownDescription": "Field name."
3086
3530
  },
3087
3531
  "values": {
3088
3532
  "type": "array",
3089
3533
  "items": {},
3090
- "description": "One or more values to be matched."
3534
+ "description": "One or more values to be matched.",
3535
+ "markdownDescription": "One or more values to be matched."
3091
3536
  }
3092
3537
  },
3093
3538
  "required": [
@@ -3095,31 +3540,37 @@
3095
3540
  "values"
3096
3541
  ],
3097
3542
  "additionalProperties": false,
3098
- "description": "Entry filter options for a Relation field."
3543
+ "description": "Entry filter options for a Relation field.",
3544
+ "markdownDescription": "Entry filter options for a Relation field."
3099
3545
  },
3100
3546
  "SelectField": {
3101
3547
  "type": "object",
3102
3548
  "properties": {
3103
3549
  "multiple": {
3104
3550
  "type": "boolean",
3105
- "description": "Whether to accept multiple values. Default: `false`."
3551
+ "description": "Whether to accept multiple values. Default: `false`.",
3552
+ "markdownDescription": "Whether to accept multiple values. Default: `false`."
3106
3553
  },
3107
3554
  "min": {
3108
3555
  "type": "number",
3109
- "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`."
3556
+ "description": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`.",
3557
+ "markdownDescription": "Minimum number of items that can be selected. Ignored if `multiple` is `false`. Default: `0`."
3110
3558
  },
3111
3559
  "max": {
3112
3560
  "type": "number",
3113
- "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`."
3561
+ "description": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`.",
3562
+ "markdownDescription": "Maximum number of items that can be selected. Ignored if `multiple` is `false`. Default: `Infinity`."
3114
3563
  },
3115
3564
  "dropdown_threshold": {
3116
3565
  "type": "number",
3117
- "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`."
3566
+ "description": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`.",
3567
+ "markdownDescription": "Maximum number of options to be displayed as radio buttons (single-select) or checkboxes (multi-select) rather than a dropdown list. Default: `5`."
3118
3568
  },
3119
3569
  "widget": {
3120
3570
  "type": "string",
3121
3571
  "const": "select",
3122
- "description": "Widget name."
3572
+ "description": "Widget name.",
3573
+ "markdownDescription": "Widget name."
3123
3574
  },
3124
3575
  "default": {
3125
3576
  "anyOf": [
@@ -3129,7 +3580,8 @@
3129
3580
  "items": {}
3130
3581
  }
3131
3582
  ],
3132
- "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value` option."
3583
+ "description": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value` option.",
3584
+ "markdownDescription": "Default value(s), which should match the options. When `multiple` is `false`, it should be a single value that matches the `value` option."
3133
3585
  },
3134
3586
  "options": {
3135
3587
  "anyOf": [
@@ -3159,7 +3611,8 @@
3159
3611
  }
3160
3612
  }
3161
3613
  ],
3162
- "description": "Options."
3614
+ "description": "Options.",
3615
+ "markdownDescription": "Options."
3163
3616
  },
3164
3617
  "required": {
3165
3618
  "anyOf": [
@@ -3173,11 +3626,13 @@
3173
3626
  }
3174
3627
  }
3175
3628
  ],
3176
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3629
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3630
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3177
3631
  },
3178
3632
  "readonly": {
3179
3633
  "type": "boolean",
3180
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3634
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3635
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3181
3636
  },
3182
3637
  "pattern": {
3183
3638
  "type": "array",
@@ -3199,27 +3654,33 @@
3199
3654
  }
3200
3655
  ],
3201
3656
  "maxItems": 2,
3202
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3657
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3658
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3203
3659
  },
3204
3660
  "name": {
3205
3661
  "type": "string",
3206
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3662
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3663
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3207
3664
  },
3208
3665
  "label": {
3209
3666
  "type": "string",
3210
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3667
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3668
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3211
3669
  },
3212
3670
  "comment": {
3213
3671
  "type": "string",
3214
- "description": "Short description of the field to be displayed in the editor UI."
3672
+ "description": "Short description of the field to be displayed in the editor UI.",
3673
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3215
3674
  },
3216
3675
  "hint": {
3217
3676
  "type": "string",
3218
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3677
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3678
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3219
3679
  },
3220
3680
  "preview": {
3221
3681
  "type": "boolean",
3222
- "description": "Whether to show the preview of the field. Default: `true`."
3682
+ "description": "Whether to show the preview of the field. Default: `true`.",
3683
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3223
3684
  },
3224
3685
  "i18n": {
3225
3686
  "anyOf": [
@@ -3239,7 +3700,8 @@
3239
3700
  "const": "none"
3240
3701
  }
3241
3702
  ],
3242
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3703
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3704
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3243
3705
  }
3244
3706
  },
3245
3707
  "required": [
@@ -3247,35 +3709,42 @@
3247
3709
  "options",
3248
3710
  "widget"
3249
3711
  ],
3250
- "description": "Select field definition."
3712
+ "description": "Select field definition.",
3713
+ "markdownDescription": "Select field definition."
3251
3714
  },
3252
3715
  "StringField": {
3253
3716
  "type": "object",
3254
3717
  "properties": {
3255
3718
  "minlength": {
3256
3719
  "type": "number",
3257
- "description": "Minimum number of characters that can be entered in the input. Default: `0`."
3720
+ "description": "Minimum number of characters that can be entered in the input. Default: `0`.",
3721
+ "markdownDescription": "Minimum number of characters that can be entered in the input. Default: `0`."
3258
3722
  },
3259
3723
  "maxlength": {
3260
3724
  "type": "number",
3261
- "description": "Maximum number of characters that can be entered in the input. Default: `Infinity`."
3725
+ "description": "Maximum number of characters that can be entered in the input. Default: `Infinity`.",
3726
+ "markdownDescription": "Maximum number of characters that can be entered in the input. Default: `Infinity`."
3262
3727
  },
3263
3728
  "before_input": {
3264
3729
  "type": "string",
3265
- "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
3730
+ "description": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string.",
3731
+ "markdownDescription": "An extra label to be displayed before the input UI. Markdown is supported. Default: empty string."
3266
3732
  },
3267
3733
  "after_input": {
3268
3734
  "type": "string",
3269
- "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
3735
+ "description": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string.",
3736
+ "markdownDescription": "An extra label to be displayed after the input UI. Markdown is supported. Default: empty string."
3270
3737
  },
3271
3738
  "widget": {
3272
3739
  "type": "string",
3273
3740
  "const": "string",
3274
- "description": "Widget name."
3741
+ "description": "Widget name.",
3742
+ "markdownDescription": "Widget name."
3275
3743
  },
3276
3744
  "default": {
3277
3745
  "type": "string",
3278
- "description": "Default value."
3746
+ "description": "Default value.",
3747
+ "markdownDescription": "Default value."
3279
3748
  },
3280
3749
  "type": {
3281
3750
  "type": "string",
@@ -3284,15 +3753,18 @@
3284
3753
  "url",
3285
3754
  "email"
3286
3755
  ],
3287
- "description": "Data type. It’s useful when the input value needs a validation. Default: `text`."
3756
+ "description": "Data type. It’s useful when the input value needs a validation. Default: `text`.",
3757
+ "markdownDescription": "Data type. It’s useful when the input value needs a validation. Default: `text`."
3288
3758
  },
3289
3759
  "prefix": {
3290
3760
  "type": "string",
3291
- "description": "A string to be prepended to the value. Default: empty string."
3761
+ "description": "A string to be prepended to the value. Default: empty string.",
3762
+ "markdownDescription": "A string to be prepended to the value. Default: empty string."
3292
3763
  },
3293
3764
  "suffix": {
3294
3765
  "type": "string",
3295
- "description": "A string to be appended to the value. Default: empty string."
3766
+ "description": "A string to be appended to the value. Default: empty string.",
3767
+ "markdownDescription": "A string to be appended to the value. Default: empty string."
3296
3768
  },
3297
3769
  "required": {
3298
3770
  "anyOf": [
@@ -3306,11 +3778,13 @@
3306
3778
  }
3307
3779
  }
3308
3780
  ],
3309
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3781
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3782
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3310
3783
  },
3311
3784
  "readonly": {
3312
3785
  "type": "boolean",
3313
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3786
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3787
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3314
3788
  },
3315
3789
  "pattern": {
3316
3790
  "type": "array",
@@ -3332,27 +3806,33 @@
3332
3806
  }
3333
3807
  ],
3334
3808
  "maxItems": 2,
3335
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3809
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3810
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3336
3811
  },
3337
3812
  "name": {
3338
3813
  "type": "string",
3339
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3814
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3815
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3340
3816
  },
3341
3817
  "label": {
3342
3818
  "type": "string",
3343
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3819
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3820
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3344
3821
  },
3345
3822
  "comment": {
3346
3823
  "type": "string",
3347
- "description": "Short description of the field to be displayed in the editor UI."
3824
+ "description": "Short description of the field to be displayed in the editor UI.",
3825
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3348
3826
  },
3349
3827
  "hint": {
3350
3828
  "type": "string",
3351
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3829
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3830
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3352
3831
  },
3353
3832
  "preview": {
3354
3833
  "type": "boolean",
3355
- "description": "Whether to show the preview of the field. Default: `true`."
3834
+ "description": "Whether to show the preview of the field. Default: `true`.",
3835
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3356
3836
  },
3357
3837
  "i18n": {
3358
3838
  "anyOf": [
@@ -3372,33 +3852,39 @@
3372
3852
  "const": "none"
3373
3853
  }
3374
3854
  ],
3375
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3855
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3856
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3376
3857
  }
3377
3858
  },
3378
3859
  "required": [
3379
3860
  "name"
3380
3861
  ],
3381
- "description": "String field definition."
3862
+ "description": "String field definition.",
3863
+ "markdownDescription": "String field definition."
3382
3864
  },
3383
3865
  "TextField": {
3384
3866
  "type": "object",
3385
3867
  "properties": {
3386
3868
  "minlength": {
3387
3869
  "type": "number",
3388
- "description": "Minimum number of characters that can be entered in the input. Default: `0`."
3870
+ "description": "Minimum number of characters that can be entered in the input. Default: `0`.",
3871
+ "markdownDescription": "Minimum number of characters that can be entered in the input. Default: `0`."
3389
3872
  },
3390
3873
  "maxlength": {
3391
3874
  "type": "number",
3392
- "description": "Maximum number of characters that can be entered in the input. Default: `Infinity`."
3875
+ "description": "Maximum number of characters that can be entered in the input. Default: `Infinity`.",
3876
+ "markdownDescription": "Maximum number of characters that can be entered in the input. Default: `Infinity`."
3393
3877
  },
3394
3878
  "widget": {
3395
3879
  "type": "string",
3396
3880
  "const": "text",
3397
- "description": "Widget name."
3881
+ "description": "Widget name.",
3882
+ "markdownDescription": "Widget name."
3398
3883
  },
3399
3884
  "default": {
3400
3885
  "type": "string",
3401
- "description": "Default value."
3886
+ "description": "Default value.",
3887
+ "markdownDescription": "Default value."
3402
3888
  },
3403
3889
  "required": {
3404
3890
  "anyOf": [
@@ -3412,11 +3898,13 @@
3412
3898
  }
3413
3899
  }
3414
3900
  ],
3415
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3901
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
3902
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3416
3903
  },
3417
3904
  "readonly": {
3418
3905
  "type": "boolean",
3419
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3906
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
3907
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3420
3908
  },
3421
3909
  "pattern": {
3422
3910
  "type": "array",
@@ -3438,27 +3926,33 @@
3438
3926
  }
3439
3927
  ],
3440
3928
  "maxItems": 2,
3441
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3929
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
3930
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3442
3931
  },
3443
3932
  "name": {
3444
3933
  "type": "string",
3445
- "description": "Unique identifier for the field. It cannot include periods and spaces."
3934
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
3935
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3446
3936
  },
3447
3937
  "label": {
3448
3938
  "type": "string",
3449
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3939
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
3940
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3450
3941
  },
3451
3942
  "comment": {
3452
3943
  "type": "string",
3453
- "description": "Short description of the field to be displayed in the editor UI."
3944
+ "description": "Short description of the field to be displayed in the editor UI.",
3945
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3454
3946
  },
3455
3947
  "hint": {
3456
3948
  "type": "string",
3457
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3949
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
3950
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3458
3951
  },
3459
3952
  "preview": {
3460
3953
  "type": "boolean",
3461
- "description": "Whether to show the preview of the field. Default: `true`."
3954
+ "description": "Whether to show the preview of the field. Default: `true`.",
3955
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3462
3956
  },
3463
3957
  "i18n": {
3464
3958
  "anyOf": [
@@ -3478,14 +3972,16 @@
3478
3972
  "const": "none"
3479
3973
  }
3480
3974
  ],
3481
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3975
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
3976
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3482
3977
  }
3483
3978
  },
3484
3979
  "required": [
3485
3980
  "name",
3486
3981
  "widget"
3487
3982
  ],
3488
- "description": "Text field definition."
3983
+ "description": "Text field definition.",
3984
+ "markdownDescription": "Text field definition."
3489
3985
  },
3490
3986
  "UuidField": {
3491
3987
  "type": "object",
@@ -3493,23 +3989,28 @@
3493
3989
  "widget": {
3494
3990
  "type": "string",
3495
3991
  "const": "uuid",
3496
- "description": "Widget name."
3992
+ "description": "Widget name.",
3993
+ "markdownDescription": "Widget name."
3497
3994
  },
3498
3995
  "default": {
3499
3996
  "type": "string",
3500
- "description": "Default value."
3997
+ "description": "Default value.",
3998
+ "markdownDescription": "Default value."
3501
3999
  },
3502
4000
  "prefix": {
3503
4001
  "type": "string",
3504
- "description": "A string to be prepended to the value. Default: empty string."
4002
+ "description": "A string to be prepended to the value. Default: empty string.",
4003
+ "markdownDescription": "A string to be prepended to the value. Default: empty string."
3505
4004
  },
3506
4005
  "use_b32_encoding": {
3507
4006
  "type": "boolean",
3508
- "description": "Whether to encode the value with Base32. Default: `false`."
4007
+ "description": "Whether to encode the value with Base32. Default: `false`.",
4008
+ "markdownDescription": "Whether to encode the value with Base32. Default: `false`."
3509
4009
  },
3510
4010
  "read_only": {
3511
4011
  "type": "boolean",
3512
- "description": "Whether to make the field read-only. Default: `true`."
4012
+ "description": "Whether to make the field read-only. Default: `true`.",
4013
+ "markdownDescription": "Whether to make the field read-only. Default: `true`."
3513
4014
  },
3514
4015
  "required": {
3515
4016
  "anyOf": [
@@ -3523,11 +4024,13 @@
3523
4024
  }
3524
4025
  }
3525
4026
  ],
3526
- "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
4027
+ "description": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean.",
4028
+ "markdownDescription": "Whether to make data input on the field required. Default: `true`. This option also affects data output if the `omit_empty_optional_fields` global output option is `true`. If i18n is enabled and the field doesn’t require input in all locales, required locale codes can be passed as an array like `[en, fr]` instead of a boolean."
3527
4029
  },
3528
4030
  "readonly": {
3529
4031
  "type": "boolean",
3530
- "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
4032
+ "description": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users.",
4033
+ "markdownDescription": "Whether to make the field read-only. Default: `false`. This is useful when a `default` value is provided and the field should not be editable by users."
3531
4034
  },
3532
4035
  "pattern": {
3533
4036
  "type": "array",
@@ -3549,27 +4052,33 @@
3549
4052
  }
3550
4053
  ],
3551
4054
  "maxItems": 2,
3552
- "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
4055
+ "description": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields.",
4056
+ "markdownDescription": "Validation format. The first argument is a regular expression matching pattern for a valid input value, and the second argument is an error message. This option has no effect on a List or Object field with subfields."
3553
4057
  },
3554
4058
  "name": {
3555
4059
  "type": "string",
3556
- "description": "Unique identifier for the field. It cannot include periods and spaces."
4060
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
4061
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3557
4062
  },
3558
4063
  "label": {
3559
4064
  "type": "string",
3560
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
4065
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
4066
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3561
4067
  },
3562
4068
  "comment": {
3563
4069
  "type": "string",
3564
- "description": "Short description of the field to be displayed in the editor UI."
4070
+ "description": "Short description of the field to be displayed in the editor UI.",
4071
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3565
4072
  },
3566
4073
  "hint": {
3567
4074
  "type": "string",
3568
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
4075
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
4076
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3569
4077
  },
3570
4078
  "preview": {
3571
4079
  "type": "boolean",
3572
- "description": "Whether to show the preview of the field. Default: `true`."
4080
+ "description": "Whether to show the preview of the field. Default: `true`.",
4081
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3573
4082
  },
3574
4083
  "i18n": {
3575
4084
  "anyOf": [
@@ -3589,41 +4098,49 @@
3589
4098
  "const": "none"
3590
4099
  }
3591
4100
  ],
3592
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
4101
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
4102
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3593
4103
  }
3594
4104
  },
3595
4105
  "required": [
3596
4106
  "name",
3597
4107
  "widget"
3598
4108
  ],
3599
- "description": "UUID field definition."
4109
+ "description": "UUID field definition.",
4110
+ "markdownDescription": "UUID field definition."
3600
4111
  },
3601
4112
  "CustomField": {
3602
4113
  "type": "object",
3603
4114
  "properties": {
3604
4115
  "widget": {
3605
4116
  "type": "string",
3606
- "description": "Widget name."
4117
+ "description": "Widget name.",
4118
+ "markdownDescription": "Widget name."
3607
4119
  },
3608
4120
  "name": {
3609
4121
  "type": "string",
3610
- "description": "Unique identifier for the field. It cannot include periods and spaces."
4122
+ "description": "Unique identifier for the field. It cannot include periods and spaces.",
4123
+ "markdownDescription": "Unique identifier for the field. It cannot include periods and spaces."
3611
4124
  },
3612
4125
  "label": {
3613
4126
  "type": "string",
3614
- "description": "Label of the field to be displayed in the editor UI. Default: `name` field value."
4127
+ "description": "Label of the field to be displayed in the editor UI. Default: `name` field value.",
4128
+ "markdownDescription": "Label of the field to be displayed in the editor UI. Default: `name` field value."
3615
4129
  },
3616
4130
  "comment": {
3617
4131
  "type": "string",
3618
- "description": "Short description of the field to be displayed in the editor UI."
4132
+ "description": "Short description of the field to be displayed in the editor UI.",
4133
+ "markdownDescription": "Short description of the field to be displayed in the editor UI."
3619
4134
  },
3620
4135
  "hint": {
3621
4136
  "type": "string",
3622
- "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
4137
+ "description": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links.",
4138
+ "markdownDescription": "Help message to be displayed below the input UI. Limited Markdown formatting is supported: bold, italic, strikethrough and links."
3623
4139
  },
3624
4140
  "preview": {
3625
4141
  "type": "boolean",
3626
- "description": "Whether to show the preview of the field. Default: `true`."
4142
+ "description": "Whether to show the preview of the field. Default: `true`.",
4143
+ "markdownDescription": "Whether to show the preview of the field. Default: `true`."
3627
4144
  },
3628
4145
  "i18n": {
3629
4146
  "anyOf": [
@@ -3643,14 +4160,16 @@
3643
4160
  "const": "none"
3644
4161
  }
3645
4162
  ],
3646
- "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
4163
+ "description": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option.",
4164
+ "markdownDescription": "Whether to enable the editor UI in locales other than the default locale. Default: `false`. `duplicate` disables the UI in non-default like `false` but automatically copies the default locale’s value to other locales. `translate` and `none` are aliases of `true` and `false`, respectively. This option only works when i18n is set up with the global and collection-level `i18n` option."
3647
4165
  }
3648
4166
  },
3649
4167
  "required": [
3650
4168
  "name",
3651
4169
  "widget"
3652
4170
  ],
3653
- "description": "Entry field using a custom widget."
4171
+ "description": "Entry field using a custom widget.",
4172
+ "markdownDescription": "Entry field using a custom widget."
3654
4173
  },
3655
4174
  "FileFormat": {
3656
4175
  "anyOf": [
@@ -3678,7 +4197,8 @@
3678
4197
  "$ref": "#/definitions/FrontMatterFormat"
3679
4198
  }
3680
4199
  ],
3681
- "description": "Supported file format."
4200
+ "description": "Supported file format.",
4201
+ "markdownDescription": "Supported file format."
3682
4202
  },
3683
4203
  "FrontMatterFormat": {
3684
4204
  "type": "string",
@@ -3687,25 +4207,29 @@
3687
4207
  "toml-frontmatter",
3688
4208
  "json-frontmatter"
3689
4209
  ],
3690
- "description": "Supported Markdown front matter format."
4210
+ "description": "Supported Markdown front matter format.",
4211
+ "markdownDescription": "Supported Markdown front matter format."
3691
4212
  },
3692
4213
  "I18nOptions": {
3693
4214
  "type": "object",
3694
4215
  "properties": {
3695
4216
  "structure": {
3696
4217
  "$ref": "#/definitions/I18nFileStructure",
3697
- "description": "File structure for entry collections. File/singleton collection must define the structure using `{{locale}}` in the `file` option."
4218
+ "description": "File structure for entry collections. File/singleton collection must define the structure using `{{locale}}` in the `file` option.",
4219
+ "markdownDescription": "File structure for entry collections. File/singleton collection must define the structure using `{{locale}}` in the `file` option."
3698
4220
  },
3699
4221
  "locales": {
3700
4222
  "type": "array",
3701
4223
  "items": {
3702
4224
  "$ref": "#/definitions/LocaleCode"
3703
4225
  },
3704
- "description": "List of all available locales."
4226
+ "description": "List of all available locales.",
4227
+ "markdownDescription": "List of all available locales."
3705
4228
  },
3706
4229
  "default_locale": {
3707
4230
  "$ref": "#/definitions/LocaleCode",
3708
- "description": "Default locale. Default: first locale in the `locales` option."
4231
+ "description": "Default locale. Default: first locale in the `locales` option.",
4232
+ "markdownDescription": "Default locale. Default: first locale in the `locales` option."
3709
4233
  },
3710
4234
  "initial_locales": {
3711
4235
  "anyOf": [
@@ -3724,11 +4248,13 @@
3724
4248
  "const": "default"
3725
4249
  }
3726
4250
  ],
3727
- "description": "Locales to be enabled when creating a new entry draft. If this option is used, users will be able to disable the output of non-default locales through the UI. See https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details."
4251
+ "description": "Locales to be enabled when creating a new entry draft. If this option is used, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details.",
4252
+ "markdownDescription": "Locales to be enabled when creating a new entry draft. If this option is used, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details."
3728
4253
  },
3729
4254
  "save_all_locales": {
3730
4255
  "type": "boolean",
3731
- "description": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content for details."
4256
+ "description": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details.",
4257
+ "markdownDescription": "Whether to save collection entries in all the locales. If `false`, users will be able to disable the output of non-default locales through the UI. See our [README](https://github.com/sveltia/sveltia-cms#disabling-non-default-locale-content) for details."
3732
4258
  },
3733
4259
  "canonical_slug": {
3734
4260
  "type": "object",
@@ -3745,11 +4271,13 @@
3745
4271
  "value"
3746
4272
  ],
3747
4273
  "additionalProperties": false,
3748
- "description": "Property name and value template used to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link localized files when entry slugs are localized. The default property name is `translationKey` used in Hugo’s multilingual support, and the default value is the default locale’s slug. See https://github.com/sveltia/sveltia-cms#localizing-entry-slugs for details."
4274
+ "description": "Property name and value template used to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link localized files when entry slugs are localized. The default property name is `translationKey` used in Hugo’s multilingual support, and the default value is the default locale’s slug. See our [README](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) for details.",
4275
+ "markdownDescription": "Property name and value template used to add a canonical slug to entry files, which helps Sveltia CMS and some frameworks to link localized files when entry slugs are localized. The default property name is `translationKey` used in Hugo’s multilingual support, and the default value is the default locale’s slug. See our [README](https://github.com/sveltia/sveltia-cms#localizing-entry-slugs) for details."
3749
4276
  },
3750
4277
  "omit_default_locale_from_filename": {
3751
4278
  "type": "boolean",
3752
- "description": "Whether to exclude the default locale from entry filenames. Default: `false`. This option applies to entry collections with the `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the `file` path ending with `.{{locale}}.<extension>`, aiming to support Zola’s multilingual sites: https://www.getzola.org/documentation/content/multilingual/."
4279
+ "description": "Whether to exclude the default locale from entry filenames. Default: `false`. This option applies to entry collections with the `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the `file` path ending with `.{{locale}}.<extension>`, aiming to support [Zola’s multilingual sites](https://www.getzola.org/documentation/content/multilingual/).",
4280
+ "markdownDescription": "Whether to exclude the default locale from entry filenames. Default: `false`. This option applies to entry collections with the `multiple_files` i18n structure enabled, as well as to file/singleton collection items with the `file` path ending with `.{{locale}}.<extension>`, aiming to support [Zola’s multilingual sites](https://www.getzola.org/documentation/content/multilingual/)."
3753
4281
  }
3754
4282
  },
3755
4283
  "required": [
@@ -3757,7 +4285,8 @@
3757
4285
  "locales"
3758
4286
  ],
3759
4287
  "additionalProperties": false,
3760
- "description": "Global, collection-level or collection file-level i18n options."
4288
+ "description": "Global, collection-level or collection file-level i18n options.",
4289
+ "markdownDescription": "Global, collection-level or collection file-level i18n options."
3761
4290
  },
3762
4291
  "I18nFileStructure": {
3763
4292
  "type": "string",
@@ -3767,14 +4296,16 @@
3767
4296
  "multiple_folders",
3768
4297
  "multiple_folders_i18n_root"
3769
4298
  ],
3770
- "description": "Internationalization (i18n) file structure type."
4299
+ "description": "Internationalization (i18n) file structure type.",
4300
+ "markdownDescription": "Internationalization (i18n) file structure type."
3771
4301
  },
3772
4302
  "CollectionFilter": {
3773
4303
  "type": "object",
3774
4304
  "properties": {
3775
4305
  "field": {
3776
4306
  "$ref": "#/definitions/FieldKeyPath",
3777
- "description": "Field name."
4307
+ "description": "Field name.",
4308
+ "markdownDescription": "Field name."
3778
4309
  },
3779
4310
  "value": {
3780
4311
  "anyOf": [
@@ -3784,7 +4315,8 @@
3784
4315
  "items": {}
3785
4316
  }
3786
4317
  ],
3787
- "description": "Field value. `null` can be used to match an undefined field. Multiple values can be defined with an array. This option or `pattern` is required."
4318
+ "description": "Field value. `null` can be used to match an undefined field. Multiple values can be defined with an array. This option or `pattern` is required.",
4319
+ "markdownDescription": "Field value. `null` can be used to match an undefined field. Multiple values can be defined with an array. This option or `pattern` is required."
3788
4320
  },
3789
4321
  "pattern": {
3790
4322
  "anyOf": [
@@ -3796,18 +4328,21 @@
3796
4328
  "format": "regex"
3797
4329
  }
3798
4330
  ],
3799
- "description": "Regular expression matching pattern."
4331
+ "description": "Regular expression matching pattern.",
4332
+ "markdownDescription": "Regular expression matching pattern."
3800
4333
  }
3801
4334
  },
3802
4335
  "required": [
3803
4336
  "field"
3804
4337
  ],
3805
4338
  "additionalProperties": false,
3806
- "description": "Collection filter options."
4339
+ "description": "Collection filter options.",
4340
+ "markdownDescription": "Collection filter options."
3807
4341
  },
3808
4342
  "FileExtension": {
3809
4343
  "type": "string",
3810
- "description": "Supported file extension."
4344
+ "description": "Supported file extension. Actually it can be any string.",
4345
+ "markdownDescription": "Supported file extension. Actually it can be any string."
3811
4346
  },
3812
4347
  "SortableFields": {
3813
4348
  "type": "object",
@@ -3817,25 +4352,29 @@
3817
4352
  "items": {
3818
4353
  "$ref": "#/definitions/FieldKeyPath"
3819
4354
  },
3820
- "description": "A list of sortable field names."
4355
+ "description": "A list of sortable field names.",
4356
+ "markdownDescription": "A list of sortable field names."
3821
4357
  },
3822
4358
  "default": {
3823
4359
  "$ref": "#/definitions/SortableFieldsDefaultOptions",
3824
- "description": "Default sort settings. See https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction for details."
4360
+ "description": "Default sort settings. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details.",
4361
+ "markdownDescription": "Default sort settings. See our [README](https://github.com/sveltia/sveltia-cms#specifying-default-sort-field-and-direction) for details."
3825
4362
  }
3826
4363
  },
3827
4364
  "required": [
3828
4365
  "fields"
3829
4366
  ],
3830
4367
  "additionalProperties": false,
3831
- "description": "A collection’s advanced sortable fields definition, which is compatible with Static CMS."
4368
+ "description": "A collection’s advanced sortable fields definition, which is compatible with Static CMS.",
4369
+ "markdownDescription": "A collection’s advanced sortable fields definition, which is compatible with Static CMS."
3832
4370
  },
3833
4371
  "SortableFieldsDefaultOptions": {
3834
4372
  "type": "object",
3835
4373
  "properties": {
3836
4374
  "field": {
3837
4375
  "$ref": "#/definitions/FieldKeyPath",
3838
- "description": "A field name to be sorted by default."
4376
+ "description": "A field name to be sorted by default.",
4377
+ "markdownDescription": "A field name to be sorted by default."
3839
4378
  },
3840
4379
  "direction": {
3841
4380
  "type": "string",
@@ -3846,25 +4385,29 @@
3846
4385
  "Descending",
3847
4386
  "None"
3848
4387
  ],
3849
- "description": "Default sort direction. Title case values are supported for Static CMS compatibility. However, `None` is the same as `ascending`. Default: `ascending`."
4388
+ "description": "Default sort direction. Title case values are supported for Static CMS compatibility. However, `None` is the same as `ascending`. Default: `ascending`.",
4389
+ "markdownDescription": "Default sort direction. Title case values are supported for Static CMS compatibility. However, `None` is the same as `ascending`. Default: `ascending`."
3850
4390
  }
3851
4391
  },
3852
4392
  "required": [
3853
4393
  "field"
3854
4394
  ],
3855
4395
  "additionalProperties": false,
3856
- "description": "The default options for the sortable fields."
4396
+ "description": "The default options for the sortable fields.",
4397
+ "markdownDescription": "The default options for the sortable fields."
3857
4398
  },
3858
4399
  "ViewFilter": {
3859
4400
  "type": "object",
3860
4401
  "properties": {
3861
4402
  "label": {
3862
4403
  "type": "string",
3863
- "description": "Label."
4404
+ "description": "Label.",
4405
+ "markdownDescription": "Label."
3864
4406
  },
3865
4407
  "field": {
3866
4408
  "$ref": "#/definitions/FieldKeyPath",
3867
- "description": "Field name."
4409
+ "description": "Field name.",
4410
+ "markdownDescription": "Field name."
3868
4411
  },
3869
4412
  "pattern": {
3870
4413
  "anyOf": [
@@ -3879,7 +4422,8 @@
3879
4422
  "type": "boolean"
3880
4423
  }
3881
4424
  ],
3882
- "description": "Regular expression matching pattern or exact value."
4425
+ "description": "Regular expression matching pattern or exact value.",
4426
+ "markdownDescription": "Regular expression matching pattern or exact value."
3883
4427
  }
3884
4428
  },
3885
4429
  "required": [
@@ -3888,18 +4432,21 @@
3888
4432
  "pattern"
3889
4433
  ],
3890
4434
  "additionalProperties": false,
3891
- "description": "View filter."
4435
+ "description": "View filter.",
4436
+ "markdownDescription": "View filter."
3892
4437
  },
3893
4438
  "ViewGroup": {
3894
4439
  "type": "object",
3895
4440
  "properties": {
3896
4441
  "label": {
3897
4442
  "type": "string",
3898
- "description": "Label."
4443
+ "description": "Label.",
4444
+ "markdownDescription": "Label."
3899
4445
  },
3900
4446
  "field": {
3901
4447
  "$ref": "#/definitions/FieldKeyPath",
3902
- "description": "Field name."
4448
+ "description": "Field name.",
4449
+ "markdownDescription": "Field name."
3903
4450
  },
3904
4451
  "pattern": {
3905
4452
  "anyOf": [
@@ -3914,7 +4461,8 @@
3914
4461
  "type": "boolean"
3915
4462
  }
3916
4463
  ],
3917
- "description": "Regular expression matching pattern or exact value."
4464
+ "description": "Regular expression matching pattern or exact value.",
4465
+ "markdownDescription": "Regular expression matching pattern or exact value."
3918
4466
  }
3919
4467
  },
3920
4468
  "required": [
@@ -3923,47 +4471,55 @@
3923
4471
  "pattern"
3924
4472
  ],
3925
4473
  "additionalProperties": false,
3926
- "description": "View group."
4474
+ "description": "View group.",
4475
+ "markdownDescription": "View group."
3927
4476
  },
3928
4477
  "EditorOptions": {
3929
4478
  "type": "object",
3930
4479
  "properties": {
3931
4480
  "preview": {
3932
4481
  "type": "boolean",
3933
- "description": "Whether to show the preview pane. Default: `true`."
4482
+ "description": "Whether to show the preview pane. Default: `true`.",
4483
+ "markdownDescription": "Whether to show the preview pane. Default: `true`."
3934
4484
  }
3935
4485
  },
3936
4486
  "required": [
3937
4487
  "preview"
3938
4488
  ],
3939
4489
  "additionalProperties": false,
3940
- "description": "Editor options."
4490
+ "description": "Editor options.",
4491
+ "markdownDescription": "Editor options."
3941
4492
  },
3942
4493
  "NestedCollectionOptions": {
3943
4494
  "type": "object",
3944
4495
  "properties": {
3945
4496
  "depth": {
3946
4497
  "type": "number",
3947
- "description": "Maximum depth to show nested items in the collection tree. Default: `Infinity`."
4498
+ "description": "Maximum depth to show nested items in the collection tree. Default: `Infinity`.",
4499
+ "markdownDescription": "Maximum depth to show nested items in the collection tree. Default: `Infinity`."
3948
4500
  },
3949
4501
  "summary": {
3950
4502
  "type": "string",
3951
- "description": "Summary template for a tree item. Default: `{{title}}`."
4503
+ "description": "Summary template for a tree item. Default: `{{title}}`.",
4504
+ "markdownDescription": "Summary template for a tree item. Default: `{{title}}`."
3952
4505
  }
3953
4506
  },
3954
4507
  "additionalProperties": false,
3955
- "description": "Nested collection options."
4508
+ "description": "Nested collection options.",
4509
+ "markdownDescription": "Nested collection options."
3956
4510
  },
3957
4511
  "CollectionMetaData": {
3958
4512
  "type": "object",
3959
4513
  "properties": {
3960
4514
  "path": {
3961
4515
  "$ref": "#/definitions/CollectionMetaDataPath",
3962
- "description": "Entry path options."
4516
+ "description": "Entry path options.",
4517
+ "markdownDescription": "Entry path options."
3963
4518
  }
3964
4519
  },
3965
4520
  "additionalProperties": false,
3966
- "description": "Collection meta data."
4521
+ "description": "Collection meta data.",
4522
+ "markdownDescription": "Collection meta data."
3967
4523
  },
3968
4524
  "CollectionMetaDataPath": {
3969
4525
  "type": "object",
@@ -3971,90 +4527,108 @@
3971
4527
  "widget": {
3972
4528
  "type": "string",
3973
4529
  "const": "string",
3974
- "description": "Widget for editing the path name."
4530
+ "description": "Widget for editing the path name.",
4531
+ "markdownDescription": "Widget for editing the path name."
3975
4532
  },
3976
4533
  "label": {
3977
4534
  "type": "string",
3978
- "description": "Label for the path editor."
4535
+ "description": "Label for the path editor.",
4536
+ "markdownDescription": "Label for the path editor."
3979
4537
  },
3980
4538
  "index_file": {
3981
4539
  "type": "string",
3982
- "description": "Index file name to be used."
4540
+ "description": "Index file name to be used.",
4541
+ "markdownDescription": "Index file name to be used."
3983
4542
  }
3984
4543
  },
3985
4544
  "additionalProperties": false,
3986
- "description": "Collection meta data’s path options."
4545
+ "description": "Collection meta data’s path options.",
4546
+ "markdownDescription": "Collection meta data’s path options."
3987
4547
  },
3988
4548
  "CollectionIndexFile": {
3989
4549
  "type": "object",
3990
4550
  "properties": {
3991
4551
  "name": {
3992
4552
  "type": "string",
3993
- "description": "Index file name without a locale or file extension. Default: `_index`, which is used for Hugo’s special index file."
4553
+ "description": "Index file name without a locale or file extension. Default: `_index`, which is used for Hugo’s special index file.",
4554
+ "markdownDescription": "Index file name without a locale or file extension. Default: `_index`, which is used for Hugo’s special index file."
3994
4555
  },
3995
4556
  "label": {
3996
4557
  "type": "string",
3997
- "description": "Label to be displayed in the editor UI. Default: Index File or its localized version."
4558
+ "description": "Label to be displayed in the editor UI. Default: Index File or its localized version.",
4559
+ "markdownDescription": "Label to be displayed in the editor UI. Default: Index File or its localized version."
3998
4560
  },
3999
4561
  "icon": {
4000
4562
  "type": "string",
4001
- "description": "Name of a Material Symbols icon to be displayed in the editor UI. Default: `home`."
4563
+ "description": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the editor UI. Default: `home`.",
4564
+ "markdownDescription": "Name of a [Material Symbols icon](https://fonts.google.com/icons?icon.set=Material+Symbols) to be displayed in the editor UI. Default: `home`."
4002
4565
  },
4003
4566
  "fields": {
4004
4567
  "type": "array",
4005
4568
  "items": {
4006
4569
  "$ref": "#/definitions/Field"
4007
4570
  },
4008
- "description": "Set of fields for the index file. If omitted, the regular entry collection `fields` will be used instead."
4571
+ "description": "Set of fields for the index file. If omitted, the regular entry collection `fields` will be used instead.",
4572
+ "markdownDescription": "Set of fields for the index file. If omitted, the regular entry collection `fields` will be used instead."
4009
4573
  },
4010
4574
  "editor": {
4011
4575
  "$ref": "#/definitions/EditorOptions",
4012
- "description": "Editor view options."
4576
+ "description": "Editor view options.",
4577
+ "markdownDescription": "Editor view options."
4013
4578
  }
4014
4579
  },
4015
4580
  "additionalProperties": false,
4016
- "description": "Index file inclusion options."
4581
+ "description": "Index file inclusion options. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details.",
4582
+ "markdownDescription": "Index file inclusion options. See our [README](https://github.com/sveltia/sveltia-cms#including-hugos-special-index-file-in-a-folder-collection) for details."
4017
4583
  },
4018
4584
  "CollectionDivider": {
4019
4585
  "type": "object",
4020
4586
  "properties": {
4021
4587
  "name": {
4022
4588
  "type": "string",
4023
- "description": "Unique identifier for the divider. Can be omitted, but it must be unique across all the collections and singletons. This property is included here because in the previous version of Sveltia CMS, a divider was defined as a collection with the `divider` option set to `true`, and the `name` option was required."
4589
+ "description": "Unique identifier for the divider. Can be omitted, but it must be unique across all the collections and singletons. This property is included here because in the previous version of Sveltia CMS, a divider was defined as a collection with the `divider` option set to `true`, and the `name` option was required.",
4590
+ "markdownDescription": "Unique identifier for the divider. Can be omitted, but it must be unique across all the collections and singletons. This property is included here because in the previous version of Sveltia CMS, a divider was defined as a collection with the `divider` option set to `true`, and the `name` option was required."
4024
4591
  },
4025
4592
  "divider": {
4026
4593
  "type": "boolean",
4027
- "description": "Whether to make this collection a divider UI in the collection list. It must be `true` to be used as a divider."
4594
+ "description": "Whether to make this collection a divider UI in the collection list. It must be `true` to be used as a divider.",
4595
+ "markdownDescription": "Whether to make this collection a divider UI in the collection list. It must be `true` to be used as a divider."
4028
4596
  }
4029
4597
  },
4030
4598
  "required": [
4031
4599
  "divider"
4032
4600
  ],
4033
4601
  "additionalProperties": false,
4034
- "description": "A divider in the collection list and singleton list."
4602
+ "description": "A divider in the collection list and singleton list. See our [README](https://github.com/sveltia/sveltia-cms#adding-dividers-to-the-collection-list) for details.",
4603
+ "markdownDescription": "A divider in the collection list and singleton list. See our [README](https://github.com/sveltia/sveltia-cms#adding-dividers-to-the-collection-list) for details."
4035
4604
  },
4036
4605
  "OutputOptions": {
4037
4606
  "type": "object",
4038
4607
  "properties": {
4039
4608
  "omit_empty_optional_fields": {
4040
4609
  "type": "boolean",
4041
- "description": "Whether to prevent fields with `required: false` and an empty value from being included in entry data output. Default: `false`."
4610
+ "description": "Whether to prevent fields with `required: false` and an empty value from being included in entry data output. Default: `false`.",
4611
+ "markdownDescription": "Whether to prevent fields with `required: false` and an empty value from being included in entry data output. Default: `false`."
4042
4612
  },
4043
4613
  "encode_file_path": {
4044
4614
  "type": "boolean",
4045
- "description": "Whether to encode the file path in File/Image fields. Default: `false`. This is useful when a file path contains special characters that need to be URL-encoded, such as spaces and parentheses. For example, `Hello World (1).webp` would be `Hello%20World%20%281%29.webp`. In general, File/Image fields should contain the original file path, and web-specific encoding should be done in the front-end code."
4615
+ "description": "Whether to encode the file path in File/Image fields. Default: `false`. This is useful when a file path contains special characters that need to be URL-encoded, such as spaces and parentheses. For example, `Hello World (1).webp` would be `Hello%20World%20%281%29.webp`. In general, File/Image fields should contain the original file path, and web-specific encoding should be done in the front-end code.",
4616
+ "markdownDescription": "Whether to encode the file path in File/Image fields. Default: `false`. This is useful when a file path contains special characters that need to be URL-encoded, such as spaces and parentheses. For example, `Hello World (1).webp` would be `Hello%20World%20%281%29.webp`. In general, File/Image fields should contain the original file path, and web-specific encoding should be done in the front-end code."
4046
4617
  },
4047
4618
  "json": {
4048
4619
  "$ref": "#/definitions/JsonFormatOptions",
4049
- "description": "JSON format options."
4620
+ "description": "JSON format options.",
4621
+ "markdownDescription": "JSON format options."
4050
4622
  },
4051
4623
  "yaml": {
4052
4624
  "$ref": "#/definitions/YamlFormatOptions",
4053
- "description": "YAML format options."
4625
+ "description": "YAML format options.",
4626
+ "markdownDescription": "YAML format options."
4054
4627
  }
4055
4628
  },
4056
4629
  "additionalProperties": false,
4057
- "description": "Data output options."
4630
+ "description": "Data output options.",
4631
+ "markdownDescription": "Data output options."
4058
4632
  },
4059
4633
  "JsonFormatOptions": {
4060
4634
  "type": "object",
@@ -4065,22 +4639,26 @@
4065
4639
  "space",
4066
4640
  "tab"
4067
4641
  ],
4068
- "description": "Indent style. Default: 'space'."
4642
+ "description": "Indent style. Default: 'space'.",
4643
+ "markdownDescription": "Indent style. Default: 'space'."
4069
4644
  },
4070
4645
  "indent_size": {
4071
4646
  "type": "number",
4072
- "description": "Indent size. Default: `2`."
4647
+ "description": "Indent size. Default: `2`.",
4648
+ "markdownDescription": "Indent size. Default: `2`."
4073
4649
  }
4074
4650
  },
4075
4651
  "additionalProperties": false,
4076
- "description": "JSON format options."
4652
+ "description": "JSON format options.",
4653
+ "markdownDescription": "JSON format options."
4077
4654
  },
4078
4655
  "YamlFormatOptions": {
4079
4656
  "type": "object",
4080
4657
  "properties": {
4081
4658
  "indent_size": {
4082
4659
  "type": "number",
4083
- "description": "Indent size. Default: `2`."
4660
+ "description": "Indent size. Default: `2`.",
4661
+ "markdownDescription": "Indent size. Default: `2`."
4084
4662
  },
4085
4663
  "quote": {
4086
4664
  "type": "string",
@@ -4089,11 +4667,13 @@
4089
4667
  "single",
4090
4668
  "double"
4091
4669
  ],
4092
- "description": "String value’s default quote type. Default: 'none'."
4670
+ "description": "String value’s default quote type. Default: 'none'.",
4671
+ "markdownDescription": "String value’s default quote type. Default: 'none'."
4093
4672
  }
4094
4673
  },
4095
4674
  "additionalProperties": false,
4096
- "description": "YAML format options."
4675
+ "description": "YAML format options.",
4676
+ "markdownDescription": "YAML format options."
4097
4677
  }
4098
4678
  },
4099
4679
  "title": "Sveltia CMS Configuration",