@cloudcannon/configuration-types 0.0.48 → 0.0.50
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.
- package/dist/cloudcannon-collections.schema.json +1999 -932
- package/dist/cloudcannon-config.documentation.schema.json +178 -217
- package/dist/cloudcannon-config.latest.schema.json +3094 -1331
- package/dist/cloudcannon-config.legacy-eleventy.schema.json +235 -287
- package/dist/cloudcannon-config.legacy-hugo.schema.json +235 -287
- package/dist/cloudcannon-config.legacy-jekyll.schema.json +235 -287
- package/dist/cloudcannon-config.legacy-reader.schema.json +235 -287
- package/dist/cloudcannon-editables.schema.json +284 -134
- package/dist/cloudcannon-initial-site-settings.documentation.schema.json +116 -0
- package/dist/cloudcannon-initial-site-settings.schema.json +171 -0
- package/dist/cloudcannon-inputs.schema.json +1644 -781
- package/dist/cloudcannon-routing.documentation.schema.json +100 -0
- package/dist/cloudcannon-routing.schema.json +144 -0
- package/dist/cloudcannon-schemas.schema.json +1788 -842
- package/dist/cloudcannon-snippets-imports.schema.json +95 -51
- package/dist/cloudcannon-snippets.schema.json +2286 -999
- package/dist/cloudcannon-structure-value.schema.json +1508 -647
- package/dist/cloudcannon-structures.schema.json +1644 -781
- package/dist/documentation.json +51604 -50649
- package/package.json +1 -1
- package/src/cascade.ts +1 -6
- package/src/collections.ts +7 -1
- package/src/configuration.ts +2 -5
- package/src/editables.ts +40 -32
- package/src/index.ts +3 -24
- package/src/initial-site-settings.ts +82 -0
- package/src/inputs.ts +4 -4
- package/src/routing.ts +92 -0
- package/src/snippets.ts +48 -41
- package/src/ssg.ts +23 -0
- package/src/structures.ts +2 -0
|
@@ -1,29 +1,42 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
|
+
"title": "Editables",
|
|
4
|
+
"description": "Configuration for editable regions in the Visual Editor, including content, block, link, image, and text editing options.",
|
|
3
5
|
"$id": "https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-editables.schema.json",
|
|
4
|
-
"
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
"$ref": "#/definitions/ContentEditable"
|
|
8
|
-
},
|
|
9
|
-
"block": {
|
|
10
|
-
"$ref": "#/definitions/BlockEditable"
|
|
11
|
-
},
|
|
12
|
-
"link": {
|
|
13
|
-
"$ref": "#/definitions/LinkEditable"
|
|
14
|
-
},
|
|
15
|
-
"image": {
|
|
16
|
-
"$ref": "#/definitions/ImageEditable"
|
|
17
|
-
},
|
|
18
|
-
"text": {
|
|
19
|
-
"$ref": "#/definitions/TextEditable"
|
|
6
|
+
"allOf": [
|
|
7
|
+
{
|
|
8
|
+
"$ref": "#/definitions/type._editables"
|
|
20
9
|
}
|
|
21
|
-
|
|
22
|
-
"additionalProperties": false,
|
|
10
|
+
],
|
|
23
11
|
"definitions": {
|
|
12
|
+
"type._editables": {
|
|
13
|
+
"title": "Editables",
|
|
14
|
+
"description": "This key defines which Rich Text editors have custom configuration for the associated WYSIWYG toolbar.\n\nFor more information, please read our documentation on [Rich Text editors](https://cloudcannon.com/documentation/articles/what-are-rich-text-editors/).\n\n## Examples\n\nIn this example, we have configured the Snippet tool for WYSIWYG toolbars in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _editables:\n content:\n snippet: true\n```",
|
|
15
|
+
"type": "object",
|
|
16
|
+
"properties": {
|
|
17
|
+
"content": {
|
|
18
|
+
"$ref": "#/definitions/ContentEditable"
|
|
19
|
+
},
|
|
20
|
+
"block": {
|
|
21
|
+
"$ref": "#/definitions/BlockEditable"
|
|
22
|
+
},
|
|
23
|
+
"link": {
|
|
24
|
+
"$ref": "#/definitions/LinkEditable"
|
|
25
|
+
},
|
|
26
|
+
"image": {
|
|
27
|
+
"$ref": "#/definitions/ImageEditable"
|
|
28
|
+
},
|
|
29
|
+
"text": {
|
|
30
|
+
"$ref": "#/definitions/TextEditable"
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"additionalProperties": false,
|
|
34
|
+
"documented": true,
|
|
35
|
+
"markdownDescription": "This key defines which Rich Text editors have custom configuration for the associated WYSIWYG toolbar.\n\nFor more information, please read our documentation on [Rich Text editors](https://cloudcannon.com/documentation/articles/what-are-rich-text-editors/).\n\n## Examples\n\nIn this example, we have configured the Snippet tool for WYSIWYG toolbars in the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n _editables:\n content:\n snippet: true\n```"
|
|
36
|
+
},
|
|
24
37
|
"ContentEditable": {
|
|
25
38
|
"title": "Content Editable",
|
|
26
|
-
"description": "
|
|
39
|
+
"description": "This key defines input options for the Content Editor.",
|
|
27
40
|
"type": "object",
|
|
28
41
|
"properties": {
|
|
29
42
|
"mime_type": {
|
|
@@ -58,7 +71,9 @@
|
|
|
58
71
|
{
|
|
59
72
|
"$ref": "#/definitions/type.paths"
|
|
60
73
|
}
|
|
61
|
-
]
|
|
74
|
+
],
|
|
75
|
+
"documented": false,
|
|
76
|
+
"title": "paths"
|
|
62
77
|
},
|
|
63
78
|
"bold": {
|
|
64
79
|
"$ref": "#/definitions/type._editables.*.bold"
|
|
@@ -164,22 +179,24 @@
|
|
|
164
179
|
}
|
|
165
180
|
},
|
|
166
181
|
"additionalProperties": false,
|
|
167
|
-
"
|
|
182
|
+
"documented": true,
|
|
183
|
+
"markdownDescription": "This key defines input options for the Content Editor."
|
|
168
184
|
},
|
|
169
185
|
"type._inputs.*.options.mime_type": {
|
|
170
186
|
"title": "Mime Type",
|
|
171
|
-
"description": "
|
|
187
|
+
"description": "This key defines what format an image is converted to prior to upload.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to convert images to WebP format prior to upload.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n mime_type: image/webp\n```",
|
|
172
188
|
"type": "string",
|
|
173
189
|
"enum": [
|
|
174
190
|
"image/jpeg",
|
|
175
191
|
"image/png",
|
|
176
192
|
"image/webp"
|
|
177
193
|
],
|
|
178
|
-
"
|
|
194
|
+
"documented": true,
|
|
195
|
+
"markdownDescription": "This key defines what format an image is converted to prior to upload.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to convert images to WebP format prior to upload.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n mime_type: image/webp\n```"
|
|
179
196
|
},
|
|
180
197
|
"type._inputs.*.options.resize_style": {
|
|
181
198
|
"title": "Resize Style",
|
|
182
|
-
"description": "
|
|
199
|
+
"description": "This key defines how image files are resized prior to upload, using a bounding box defined by `width` and `height` options.\n\nValid values are `cover`, `contain`, `crop`, or `stretch`:\n\n* `cover` keeps aspect ratio and ensures the image covers the bounding box\n* `contain` keeps aspect ratio and ensures the image fits inside the bounding box\n* `crop` prompts the user with and interface to select an aspect-ratio-respecting area\n* `stretch` ignores aspect ratio and resizes the image to the bounding box\n\nThis key does not apply to existing images, and does not work if `width` and `height` options are not defined.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to resize images using the `cover` style to ensure images cover the bounding box while maintaining aspect ratio.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n```",
|
|
183
200
|
"default": "contain",
|
|
184
201
|
"type": "string",
|
|
185
202
|
"enum": [
|
|
@@ -188,74 +205,94 @@
|
|
|
188
205
|
"stretch",
|
|
189
206
|
"crop"
|
|
190
207
|
],
|
|
191
|
-
"
|
|
208
|
+
"documented": true,
|
|
209
|
+
"markdownDescription": "This key defines how image files are resized prior to upload, using a bounding box defined by `width` and `height` options.\n\nValid values are `cover`, `contain`, `crop`, or `stretch`:\n\n* `cover` keeps aspect ratio and ensures the image covers the bounding box\n* `contain` keeps aspect ratio and ensures the image fits inside the bounding box\n* `crop` prompts the user with and interface to select an aspect-ratio-respecting area\n* `stretch` ignores aspect ratio and resizes the image to the bounding box\n\nThis key does not apply to existing images, and does not work if `width` and `height` options are not defined.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to resize images using the `cover` style to ensure images cover the bounding box while maintaining aspect ratio.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n```"
|
|
192
210
|
},
|
|
193
211
|
"type._inputs.*.options.width": {
|
|
194
212
|
"title": "Width",
|
|
195
|
-
"description": "
|
|
213
|
+
"description": "This key defines the width of the bounding box used in the resizing method defined by `resize_style`.",
|
|
196
214
|
"type": "number",
|
|
197
|
-
"
|
|
215
|
+
"documented": true,
|
|
216
|
+
"markdownDescription": "This key defines the width of the bounding box used in the resizing method defined by `resize_style`."
|
|
198
217
|
},
|
|
199
218
|
"type._inputs.*.options.height": {
|
|
200
219
|
"title": "Height",
|
|
201
|
-
"description": "
|
|
220
|
+
"description": "This key defines the height of the bounding box used in the resizing method defined by `resize_style`.\n\n## Examples\n\nIn this example, we have configured the height of the bounding box for an *Image Input*.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n```",
|
|
202
221
|
"type": "number",
|
|
203
|
-
"
|
|
222
|
+
"documented": true,
|
|
223
|
+
"markdownDescription": "This key defines the height of the bounding box used in the resizing method defined by `resize_style`.\n\n## Examples\n\nIn this example, we have configured the height of the bounding box for an *Image Input*.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n```"
|
|
204
224
|
},
|
|
205
225
|
"type._inputs.*.options.expandable": {
|
|
206
226
|
"title": "Expandable",
|
|
207
|
-
"description": "
|
|
227
|
+
"description": "This key defines whether you can upscale an image to fit the bounding box while resizing an image prior to upload.\n\nHas no effect if files are not resized.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to allow upscaling images to fit the bounding box while resizing.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n expandable: true\n```",
|
|
208
228
|
"default": false,
|
|
209
229
|
"type": "boolean",
|
|
210
|
-
"
|
|
230
|
+
"documented": true,
|
|
231
|
+
"markdownDescription": "This key defines whether you can upscale an image to fit the bounding box while resizing an image prior to upload.\n\nHas no effect if files are not resized.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to allow upscaling images to fit the bounding box while resizing.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n expandable: true\n```"
|
|
211
232
|
},
|
|
212
233
|
"type._inputs.*.options.image_size_attributes": {
|
|
213
234
|
"title": "Image Size Attributes",
|
|
214
|
-
"description": "
|
|
235
|
+
"description": "This key toggles whether CloudCannon will instruct a rich text editor to save `width` and `height` attributes on image elements.\n\nSetting this key to `true` will instruct the rich text editor to save `width` and `height` attributes on image elements. This can prevent pop-in as a page loads.\n\nBy default, this key is `false` (i.e., width and height attributes are not saved on image elements). This defaults to `true` if the [Image Size Attributes site flag](https://cloudcannon.com/documentation/articles/legacy-option-flags/#image-size-attributes-default-behaviour) is enabled (this is enabled for sites created before June 23 2023, in order to keep those sites working).\n\n## Examples\n\nIn this example, CloudCannon will save width and height attributes on image elements in a *Rich Text Input*.\n\n```yaml\n_inputs:\n content:\n type: markdown\n options:\n image_size_attributes: true\n```",
|
|
215
236
|
"default": true,
|
|
216
237
|
"type": "boolean",
|
|
217
|
-
"
|
|
238
|
+
"documented": true,
|
|
239
|
+
"markdownDescription": "This key toggles whether CloudCannon will instruct a rich text editor to save `width` and `height` attributes on image elements.\n\nSetting this key to `true` will instruct the rich text editor to save `width` and `height` attributes on image elements. This can prevent pop-in as a page loads.\n\nBy default, this key is `false` (i.e., width and height attributes are not saved on image elements). This defaults to `true` if the [Image Size Attributes site flag](https://cloudcannon.com/documentation/articles/legacy-option-flags/#image-size-attributes-default-behaviour) is enabled (this is enabled for sites created before June 23 2023, in order to keep those sites working).\n\n## Examples\n\nIn this example, CloudCannon will save width and height attributes on image elements in a *Rich Text Input*.\n\n```yaml\n_inputs:\n content:\n type: markdown\n options:\n image_size_attributes: true\n```"
|
|
218
240
|
},
|
|
219
241
|
"type._inputs.*.options.allowed_sources": {
|
|
220
242
|
"title": "Allowed Sources",
|
|
221
|
-
"description": "
|
|
243
|
+
"description": "This key defines which sources and DAMs you are allowed to upload to and browse.\n\nThe value can be an array of strings. Valid values include `site-files` and the reference key for any DAM connected to your site.\n\nIf `site-files` is omitted from the array, site files will not be available as an asset source for this input.\n\n## Examples\n\nIn this example, we have configured allowed sources for an *Image Input*.\n\n```yaml\n_inputs:\n image:\n type: image\n options:\n allowed_sources:\n - site-files\n - my-cloudinary-dam\n```",
|
|
222
244
|
"type": "array",
|
|
223
245
|
"items": {
|
|
224
|
-
"type": "string"
|
|
246
|
+
"type": "string",
|
|
247
|
+
"documented": true,
|
|
248
|
+
"title": "allowed_sources[*]",
|
|
249
|
+
"description": "This key defines which sources and DAMs you are allowed to upload to and browse.\n\nThe value can be an array of strings. Valid values include `site-files` and the reference key for any DAM connected to your site.\n\nIf `site-files` is omitted from the array, site files will not be available as an asset source for this input.\n\n## Examples\n\nIn this example, we have configured allowed sources for an *Image Input*.\n\n```yaml\n_inputs:\n image:\n type: image\n options:\n allowed_sources:\n - site-files\n - my-cloudinary-dam\n```",
|
|
250
|
+
"markdownDescription": "This key defines which sources and DAMs you are allowed to upload to and browse.\n\nThe value can be an array of strings. Valid values include `site-files` and the reference key for any DAM connected to your site.\n\nIf `site-files` is omitted from the array, site files will not be available as an asset source for this input.\n\n## Examples\n\nIn this example, we have configured allowed sources for an *Image Input*.\n\n```yaml\n_inputs:\n image:\n type: image\n options:\n allowed_sources:\n - site-files\n - my-cloudinary-dam\n```"
|
|
225
251
|
},
|
|
226
|
-
"
|
|
252
|
+
"documented": true,
|
|
253
|
+
"markdownDescription": "This key defines which sources and DAMs you are allowed to upload to and browse.\n\nThe value can be an array of strings. Valid values include `site-files` and the reference key for any DAM connected to your site.\n\nIf `site-files` is omitted from the array, site files will not be available as an asset source for this input.\n\n## Examples\n\nIn this example, we have configured allowed sources for an *Image Input*.\n\n```yaml\n_inputs:\n image:\n type: image\n options:\n allowed_sources:\n - site-files\n - my-cloudinary-dam\n```"
|
|
227
254
|
},
|
|
228
255
|
"type._inputs.*.options.prevent_resize_existing_files": {
|
|
229
256
|
"title": "Prevent Resize Existing Files",
|
|
230
|
-
"description": "
|
|
257
|
+
"description": "This key toggles whether CloudCannon will skip the image resizing process configured for this input when selecting existing images.\n\nSetting this key to `true` will skip the image resizing process when selecting existing images.\n\n## Examples\n\nIn this example, CloudCannon will skip the image resizing process when selecting existing images for an *Image Input*.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n prevent_resize_existing_files: true\n```",
|
|
231
258
|
"default": false,
|
|
232
259
|
"type": "boolean",
|
|
233
|
-
"
|
|
260
|
+
"documented": true,
|
|
261
|
+
"markdownDescription": "This key toggles whether CloudCannon will skip the image resizing process configured for this input when selecting existing images.\n\nSetting this key to `true` will skip the image resizing process when selecting existing images.\n\n## Examples\n\nIn this example, CloudCannon will skip the image resizing process when selecting existing images for an *Image Input*.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n width: 1200\n height: 600\n resize_style: cover\n prevent_resize_existing_files: true\n```"
|
|
234
262
|
},
|
|
235
263
|
"type._inputs.*.options.sizes": {
|
|
236
264
|
"title": "Sizes",
|
|
237
|
-
"description": "
|
|
265
|
+
"description": "This key defines definitions for creating additional images of different sizes when uploading or selecting existing files.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to create additional images of different sizes when uploading or selecting files.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n - size: 3x\n```",
|
|
238
266
|
"type": "array",
|
|
239
267
|
"items": {
|
|
240
268
|
"type": "object",
|
|
241
269
|
"properties": {
|
|
242
270
|
"size": {
|
|
243
|
-
"description": "
|
|
271
|
+
"description": "This key defines a number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).\n\n## Examples\n\nIn this example, we have configured a size definition for an *Image Input* to create a 2x relative size image.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n```",
|
|
244
272
|
"type": "string",
|
|
245
|
-
"
|
|
273
|
+
"documented": true,
|
|
274
|
+
"title": "size",
|
|
275
|
+
"markdownDescription": "This key defines a number suffixed with \"x\" (relative size) or \"w\" (fixed width) for setting the dimensions of the image (e.g. 2x, 3x, 100w, 360w).\n\n## Examples\n\nIn this example, we have configured a size definition for an *Image Input* to create a 2x relative size image.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n```"
|
|
246
276
|
},
|
|
247
277
|
"target": {
|
|
248
|
-
"description": "
|
|
278
|
+
"description": "This key defines a reference to another input that is given the path to this additional image file.",
|
|
249
279
|
"type": "string",
|
|
250
|
-
"
|
|
280
|
+
"documented": true,
|
|
281
|
+
"title": "target",
|
|
282
|
+
"markdownDescription": "This key defines a reference to another input that is given the path to this additional image file."
|
|
251
283
|
}
|
|
252
284
|
},
|
|
253
285
|
"required": [
|
|
254
286
|
"size"
|
|
255
287
|
],
|
|
256
|
-
"additionalProperties": false
|
|
288
|
+
"additionalProperties": false,
|
|
289
|
+
"documented": true,
|
|
290
|
+
"title": "sizes[*]",
|
|
291
|
+
"description": "This key represents an individual size definition in the `options.sizes` array for *Image Inputs*.\n\nThe value is an object that can contain `size` and `target` properties.\n\n## Examples\n\nIn this example, we have configured a size definition for an *Image Input*.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n target: hero_image_2x\n```",
|
|
292
|
+
"markdownDescription": "This key represents an individual size definition in the `options.sizes` array for *Image Inputs*.\n\nThe value is an object that can contain `size` and `target` properties.\n\n## Examples\n\nIn this example, we have configured a size definition for an *Image Input*.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n target: hero_image_2x\n```"
|
|
257
293
|
},
|
|
258
|
-
"
|
|
294
|
+
"documented": true,
|
|
295
|
+
"markdownDescription": "This key defines definitions for creating additional images of different sizes when uploading or selecting existing files.\n\n## Examples\n\nIn this example, we have configured an *Image Input* to create additional images of different sizes when uploading or selecting files.\n\n```yaml\n_inputs:\n hero_image:\n type: image\n options:\n sizes:\n - size: 2x\n - size: 3x\n```"
|
|
259
296
|
},
|
|
260
297
|
"type.paths": {
|
|
261
298
|
"title": "Paths",
|
|
@@ -283,231 +320,330 @@
|
|
|
283
320
|
"$ref": "#/definitions/paths.uploads_use_relative_path"
|
|
284
321
|
}
|
|
285
322
|
},
|
|
286
|
-
"additionalProperties": false
|
|
323
|
+
"additionalProperties": false,
|
|
324
|
+
"documented": true,
|
|
325
|
+
"description": "This key defines paths for your Rich Text editors or File inputs.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `paths` will default to any\nvalues configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\n## Examples\n\nIn this example, we have configured paths for the `blog` Collection to set custom upload and static paths.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads: /uploads/blog/\n static: /assets/\n```",
|
|
326
|
+
"markdownDescription": "This key defines paths for your Rich Text editors or File inputs.\n\nIf undefined at higher levels of the [configuration cascade](https://cloudcannon.com/documentation/articles/using-the-configuration-cascade/), `paths` will default to any\nvalues configured in the [CloudCannon configuration file](https://cloudcannon.com/documentation/articles/what-is-the-cloudcannon-configuration-file/).\n\n## Examples\n\nIn this example, we have configured paths for the `blog` Collection to set custom upload and static paths.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads: /uploads/blog/\n static: /assets/\n```"
|
|
287
327
|
},
|
|
288
328
|
"paths.static": {
|
|
289
|
-
"type": "string"
|
|
329
|
+
"type": "string",
|
|
330
|
+
"documented": true,
|
|
331
|
+
"title": "static",
|
|
332
|
+
"description": "This key defines the path for the location of statically copied assets.\n\n## Examples\n\nIn this example, we have configured the static path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n static: /assets/\n```",
|
|
333
|
+
"markdownDescription": "This key defines the path for the location of statically copied assets.\n\n## Examples\n\nIn this example, we have configured the static path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n static: /assets/\n```"
|
|
290
334
|
},
|
|
291
335
|
"paths.uploads": {
|
|
292
336
|
"default": "uploads",
|
|
293
|
-
"type": "string"
|
|
337
|
+
"type": "string",
|
|
338
|
+
"documented": true,
|
|
339
|
+
"title": "uploads",
|
|
340
|
+
"description": "This key defines the paths for the default location of newly uploaded site files.\n\nYou can use [dynamic placeholders](https://cloudcannon.com/documentation/articles/configure-your-template-strings/) for `uploads` and `dam_uploads`.\n\n## Examples\n\nIn this example, we have configured the uploads path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads: /uploads/blog/\n```",
|
|
341
|
+
"markdownDescription": "This key defines the paths for the default location of newly uploaded site files.\n\nYou can use [dynamic placeholders](https://cloudcannon.com/documentation/articles/configure-your-template-strings/) for `uploads` and `dam_uploads`.\n\n## Examples\n\nIn this example, we have configured the uploads path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads: /uploads/blog/\n```"
|
|
294
342
|
},
|
|
295
343
|
"paths.uploads_filename": {
|
|
296
|
-
"type": "string"
|
|
344
|
+
"type": "string",
|
|
345
|
+
"documented": true,
|
|
346
|
+
"title": "uploads_filename",
|
|
347
|
+
"description": "This key defines the path for the name of the uploaded file.\n\n## Examples\n\nIn this example, we have configured the uploads filename path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads_filename: '{filename|slugify}'\n```",
|
|
348
|
+
"markdownDescription": "This key defines the path for the name of the uploaded file.\n\n## Examples\n\nIn this example, we have configured the uploads filename path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n uploads_filename: '{filename|slugify}'\n```"
|
|
297
349
|
},
|
|
298
350
|
"paths.dam_uploads": {
|
|
299
|
-
"type": "string"
|
|
351
|
+
"type": "string",
|
|
352
|
+
"documented": true,
|
|
353
|
+
"title": "dam_uploads",
|
|
354
|
+
"description": "This key defines the path for the default location of newly uploaded [DAM](https://cloudcannon.com/documentation/articles/introduction-to-assets-and-dams/)\nfiles.\n\nYou can use [dynamic placeholders](https://cloudcannon.com/documentation/articles/configure-your-template-strings/) for `uploads` and `dam_uploads`.\n\n## Examples\n\nIn this example, we have configured the DAM uploads path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n dam_uploads: /dam/uploads/blog/\n```",
|
|
355
|
+
"markdownDescription": "This key defines the path for the default location of newly uploaded [DAM](https://cloudcannon.com/documentation/articles/introduction-to-assets-and-dams/)\nfiles.\n\nYou can use [dynamic placeholders](https://cloudcannon.com/documentation/articles/configure-your-template-strings/) for `uploads` and `dam_uploads`.\n\n## Examples\n\nIn this example, we have configured the DAM uploads path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n dam_uploads: /dam/uploads/blog/\n```"
|
|
300
356
|
},
|
|
301
357
|
"paths.dam_uploads_filename": {
|
|
302
|
-
"type": "string"
|
|
358
|
+
"type": "string",
|
|
359
|
+
"documented": true,
|
|
360
|
+
"title": "dam_uploads_filename",
|
|
361
|
+
"description": "This key defines the path for the name of the uploaded file, when uploading [DAM](https://cloudcannon.com/documentation/articles/introduction-to-assets-and-dams/) files.\n\n## Examples\n\nIn this example, we have configured the DAM uploads filename path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n dam_uploads_filename: '{filename|slugify}'\n```",
|
|
362
|
+
"markdownDescription": "This key defines the path for the name of the uploaded file, when uploading [DAM](https://cloudcannon.com/documentation/articles/introduction-to-assets-and-dams/) files.\n\n## Examples\n\nIn this example, we have configured the DAM uploads filename path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n dam_uploads_filename: '{filename|slugify}'\n```"
|
|
303
363
|
},
|
|
304
364
|
"paths.dam_static": {
|
|
305
|
-
"type": "string"
|
|
365
|
+
"type": "string",
|
|
366
|
+
"documented": true,
|
|
367
|
+
"title": "dam_static",
|
|
368
|
+
"description": "This key defines the path for the location of statically copied assets for [DAM](https://cloudcannon.com/documentation/articles/introduction-to-assets-and-dams/) files.\n\n## Examples\n\nIn this example, we have configured the DAM static path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n dam_static: /assets/dam/\n```",
|
|
369
|
+
"markdownDescription": "This key defines the path for the location of statically copied assets for [DAM](https://cloudcannon.com/documentation/articles/introduction-to-assets-and-dams/) files.\n\n## Examples\n\nIn this example, we have configured the DAM static path for the `blog` Collection.\n\n```yaml\ncollections_config:\n blog:\n paths:\n dam_static: /assets/dam/\n```"
|
|
306
370
|
},
|
|
307
371
|
"paths.uploads_use_relative_path": {
|
|
308
372
|
"default": false,
|
|
309
|
-
"type": "boolean"
|
|
373
|
+
"type": "boolean",
|
|
374
|
+
"documented": true,
|
|
375
|
+
"title": "uploads_use_relative_path",
|
|
376
|
+
"description": "This key toggles whether CloudCannon will use relative paths instead of absolute paths for uploaded files.\n\nSetting this key to `true` will make CloudCannon use relative paths for uploaded files, which are relative to the file being edited rather than the repository root.\n\n## Examples\n\nIn this example, we have configured uploads to use relative paths for files uploaded in the Content Editor.\n\n```yaml\n_editables:\n content:\n paths:\n uploads_use_relative_path: true\n```",
|
|
377
|
+
"markdownDescription": "This key toggles whether CloudCannon will use relative paths instead of absolute paths for uploaded files.\n\nSetting this key to `true` will make CloudCannon use relative paths for uploaded files, which are relative to the file being edited rather than the repository root.\n\n## Examples\n\nIn this example, we have configured uploads to use relative paths for files uploaded in the Content Editor.\n\n```yaml\n_editables:\n content:\n paths:\n uploads_use_relative_path: true\n```"
|
|
310
378
|
},
|
|
311
379
|
"type._editables.*.bold": {
|
|
312
|
-
"description": "
|
|
380
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to bold selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to bold selected text.",
|
|
313
381
|
"default": true,
|
|
314
382
|
"type": "boolean",
|
|
315
|
-
"
|
|
383
|
+
"documented": true,
|
|
384
|
+
"title": "bold",
|
|
385
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to bold selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to bold selected text."
|
|
316
386
|
},
|
|
317
387
|
"type._editables.*.copyformatting": {
|
|
318
|
-
"description": "
|
|
388
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to copy formatting from selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to copy formatting from selected text. Applies to `bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript` formatting. Does not copy other styles or formatting.",
|
|
319
389
|
"default": false,
|
|
320
390
|
"type": "boolean",
|
|
321
|
-
"
|
|
391
|
+
"documented": true,
|
|
392
|
+
"title": "copyformatting",
|
|
393
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to copy formatting from selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to copy formatting from selected text. Applies to `bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript` formatting. Does not copy other styles or formatting."
|
|
322
394
|
},
|
|
323
395
|
"type._editables.*.italic": {
|
|
324
|
-
"description": "
|
|
396
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to italicize selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to italicize selected text.",
|
|
325
397
|
"default": true,
|
|
326
398
|
"type": "boolean",
|
|
327
|
-
"
|
|
399
|
+
"documented": true,
|
|
400
|
+
"title": "italic",
|
|
401
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to italicize selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to italicize selected text."
|
|
328
402
|
},
|
|
329
403
|
"type._editables.*.link": {
|
|
330
|
-
"description": "
|
|
404
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to create a hyperlink around selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to create a hyperlink around selected text.",
|
|
331
405
|
"default": true,
|
|
332
406
|
"type": "boolean",
|
|
333
|
-
"
|
|
407
|
+
"documented": true,
|
|
408
|
+
"title": "link",
|
|
409
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to create a hyperlink around selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to create a hyperlink around selected text."
|
|
334
410
|
},
|
|
335
411
|
"type._editables.*.redo": {
|
|
336
|
-
"description": "
|
|
412
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to redo recent edits undone with `undo`.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to redo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.",
|
|
337
413
|
"default": false,
|
|
338
414
|
"type": "boolean",
|
|
339
|
-
"
|
|
415
|
+
"documented": true,
|
|
416
|
+
"title": "redo",
|
|
417
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to redo recent edits undone with `undo`.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to redo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts."
|
|
340
418
|
},
|
|
341
419
|
"type._editables.*.removeformat": {
|
|
342
|
-
"description": "
|
|
420
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to remove formatting from selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to remove formatting. Applies to `bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript` formatting. Does not remove other styles or formatting.",
|
|
343
421
|
"default": true,
|
|
344
422
|
"type": "boolean",
|
|
345
|
-
"
|
|
423
|
+
"documented": true,
|
|
424
|
+
"title": "removeformat",
|
|
425
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to remove formatting from selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to remove formatting. Applies to `bold`, `italic`, `underline`, `strike`, `subscript`, and `superscript` formatting. Does not remove other styles or formatting."
|
|
346
426
|
},
|
|
347
427
|
"type._editables.*.strike": {
|
|
348
|
-
"description": "
|
|
428
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to strike through selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to strike through selected text.",
|
|
349
429
|
"default": false,
|
|
350
430
|
"type": "boolean",
|
|
351
|
-
"
|
|
431
|
+
"documented": true,
|
|
432
|
+
"title": "strike",
|
|
433
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to strike through selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to strike through selected text."
|
|
352
434
|
},
|
|
353
435
|
"type._editables.*.subscript": {
|
|
354
|
-
"description": "
|
|
436
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to subscript selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to subscript selected text.",
|
|
355
437
|
"default": false,
|
|
356
438
|
"type": "boolean",
|
|
357
|
-
"
|
|
439
|
+
"documented": true,
|
|
440
|
+
"title": "subscript",
|
|
441
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to subscript selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to subscript selected text."
|
|
358
442
|
},
|
|
359
443
|
"type._editables.*.superscript": {
|
|
360
|
-
"description": "
|
|
444
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to superscript selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to superscript selected text.",
|
|
361
445
|
"default": false,
|
|
362
446
|
"type": "boolean",
|
|
363
|
-
"
|
|
447
|
+
"documented": true,
|
|
448
|
+
"title": "superscript",
|
|
449
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to superscript selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to superscript selected text."
|
|
364
450
|
},
|
|
365
451
|
"type._editables.*.underline": {
|
|
366
|
-
"description": "
|
|
452
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to underline selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to underline selected text.",
|
|
367
453
|
"default": false,
|
|
368
454
|
"type": "boolean",
|
|
369
|
-
"
|
|
455
|
+
"documented": true,
|
|
456
|
+
"title": "underline",
|
|
457
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to underline selected text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to underline selected text."
|
|
370
458
|
},
|
|
371
459
|
"type._editables.*.undo": {
|
|
372
|
-
"description": "
|
|
460
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to undo recent edits.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts.",
|
|
373
461
|
"default": false,
|
|
374
462
|
"type": "boolean",
|
|
375
|
-
"
|
|
463
|
+
"documented": true,
|
|
464
|
+
"title": "undo",
|
|
465
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to undo recent edits.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to undo recent edits. Undo is always enabled through standard OS-specific keyboard shortcuts."
|
|
376
466
|
},
|
|
377
467
|
"type._editables.*.remove_custom_markup": {
|
|
378
|
-
"description": "
|
|
468
|
+
"description": "This key toggles whether CloudCannon will allow you to strip custom markup from content edited in a rich text editor, allowing you to clean files of unnecessary HTML content.\n\nSetting this key to `true` will enable stripping custom markup from content. The `remove_custom_markup` key is disabled if `allow_custom_markup` is enabled.",
|
|
379
469
|
"type": "boolean",
|
|
380
|
-
"
|
|
470
|
+
"documented": true,
|
|
471
|
+
"title": "remove_custom_markup",
|
|
472
|
+
"markdownDescription": "This key toggles whether CloudCannon will allow you to strip custom markup from content edited in a rich text editor, allowing you to clean files of unnecessary HTML content.\n\nSetting this key to `true` will enable stripping custom markup from content. The `remove_custom_markup` key is disabled if `allow_custom_markup` is enabled."
|
|
381
473
|
},
|
|
382
474
|
"type._editables.*.allow_custom_markup": {
|
|
383
|
-
"description": "
|
|
475
|
+
"description": "This key toggles whether CloudCannon will allow you to edit custom markup in rich text editors and explicitly accept the risk of unintentionally deleting elements that cannot be recreated.\n\nSetting this key to `true` will enable editing of custom markup. When using `allow_custom_markup` outside of editable regions, content that uses JavaScript will not be editable for security reasons. These inputs will appear as uneditable snippets.",
|
|
384
476
|
"type": "boolean",
|
|
385
|
-
"
|
|
477
|
+
"documented": true,
|
|
478
|
+
"title": "allow_custom_markup",
|
|
479
|
+
"markdownDescription": "This key toggles whether CloudCannon will allow you to edit custom markup in rich text editors and explicitly accept the risk of unintentionally deleting elements that cannot be recreated.\n\nSetting this key to `true` will enable editing of custom markup. When using `allow_custom_markup` outside of editable regions, content that uses JavaScript will not be editable for security reasons. These inputs will appear as uneditable snippets."
|
|
386
480
|
},
|
|
387
481
|
"type._editables.*.blockquote": {
|
|
388
|
-
"description": "
|
|
482
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to wrap selected blocks of text in a block quote.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to wrap selected blocks of text in a block quote.",
|
|
389
483
|
"default": true,
|
|
390
484
|
"type": "boolean",
|
|
391
|
-
"
|
|
485
|
+
"documented": true,
|
|
486
|
+
"title": "blockquote",
|
|
487
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to wrap selected blocks of text in a block quote.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to wrap selected blocks of text in a block quote."
|
|
392
488
|
},
|
|
393
489
|
"type._editables.*.bulletedlist": {
|
|
394
|
-
"description": "
|
|
490
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert an unordered list or convert selected text to an unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert an unordered list or convert selected text to an unordered list.",
|
|
395
491
|
"default": true,
|
|
396
492
|
"type": "boolean",
|
|
397
|
-
"
|
|
493
|
+
"documented": true,
|
|
494
|
+
"title": "bulletedlist",
|
|
495
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert an unordered list or convert selected text to an unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert an unordered list or convert selected text to an unordered list."
|
|
398
496
|
},
|
|
399
497
|
"type._editables.*.center": {
|
|
400
|
-
"description": "
|
|
498
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to center align selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to center align selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file.",
|
|
401
499
|
"type": "string",
|
|
402
|
-
"
|
|
500
|
+
"documented": true,
|
|
501
|
+
"title": "center",
|
|
502
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to center align selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to center align selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file."
|
|
403
503
|
},
|
|
404
504
|
"type._editables.*.code_inline": {
|
|
405
|
-
"description": "
|
|
505
|
+
"description": "This key toggles whether CloudCannon will display a control in your WYSIWYG toolbar to create an inline code element, containing any selected text.\n\nSetting this key to `true` will enable a control in your WYSIWYG toolbar to create an inline code element.\n\nBy default, this key is `false` (i.e., the inline code control is not displayed).",
|
|
406
506
|
"default": false,
|
|
407
507
|
"type": "boolean",
|
|
408
|
-
"
|
|
508
|
+
"documented": true,
|
|
509
|
+
"title": "code_inline",
|
|
510
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a control in your WYSIWYG toolbar to create an inline code element, containing any selected text.\n\nSetting this key to `true` will enable a control in your WYSIWYG toolbar to create an inline code element.\n\nBy default, this key is `false` (i.e., the inline code control is not displayed)."
|
|
409
511
|
},
|
|
410
512
|
"type._editables.*.code_block": {
|
|
411
|
-
"description": "
|
|
513
|
+
"description": "This key toggles whether CloudCannon will display a control in your WYSIWYG toolbar to insert a code block in editable regions.\n\nSetting this key to `true` will enable a control in your WYSIWYG toolbar to insert a code block.\n\nBy default, this key is `false` (i.e., the code block control is not displayed).",
|
|
412
514
|
"default": false,
|
|
413
515
|
"type": "boolean",
|
|
414
|
-
"
|
|
516
|
+
"documented": true,
|
|
517
|
+
"title": "code_block",
|
|
518
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a control in your WYSIWYG toolbar to insert a code block in editable regions.\n\nSetting this key to `true` will enable a control in your WYSIWYG toolbar to insert a code block.\n\nBy default, this key is `false` (i.e., the code block control is not displayed)."
|
|
415
519
|
},
|
|
416
520
|
"type._editables.*.code": {
|
|
417
|
-
"description": "
|
|
521
|
+
"description": "This key toggles whether CloudCannon will display tools in your WYSIWYG toolbar to turn selected text into inline code and selected text into a code block.\n\nSetting this key to `true` will enable two tools in your WYSIWYG toolbar to turn selected text into inline code and selected text into a code block.",
|
|
418
522
|
"default": false,
|
|
419
523
|
"type": "boolean",
|
|
420
|
-
"
|
|
524
|
+
"documented": true,
|
|
525
|
+
"title": "code",
|
|
526
|
+
"markdownDescription": "This key toggles whether CloudCannon will display tools in your WYSIWYG toolbar to turn selected text into inline code and selected text into a code block.\n\nSetting this key to `true` will enable two tools in your WYSIWYG toolbar to turn selected text into inline code and selected text into a code block."
|
|
421
527
|
},
|
|
422
528
|
"type._editables.*.embed": {
|
|
423
|
-
"description": "
|
|
529
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a region of raw HTML for YouTube, Vimeo, social media posts, or other media.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a region of raw HTML. Embedded content is sanitized to mitigate XSS risks, which includes removing `style` tags. Embeds containing `script` tags are not loaded a rich text editor.",
|
|
424
530
|
"default": false,
|
|
425
531
|
"type": "boolean",
|
|
426
|
-
"
|
|
532
|
+
"documented": true,
|
|
533
|
+
"title": "embed",
|
|
534
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a region of raw HTML for YouTube, Vimeo, social media posts, or other media.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a region of raw HTML. Embedded content is sanitized to mitigate XSS risks, which includes removing `style` tags. Embeds containing `script` tags are not loaded a rich text editor."
|
|
427
535
|
},
|
|
428
536
|
"type._editables.*.format": {
|
|
429
|
-
"description": "
|
|
537
|
+
"description": "This key toggles whether CloudCannon will display a dropdown menu tool in your WYSIWYG toolbar for structured text.\n\nSetting this key to `true` will enable a dropdown menu tool in your WYSIWYG toolbar for structured text. Valid values include for `p`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `pre`, `address`, and `div`. Include a space between each values, e.g. `format: p h1 h2`.",
|
|
430
538
|
"default": "p h1 h2 h3 h4 h5 h6",
|
|
431
539
|
"type": "string",
|
|
432
|
-
"
|
|
540
|
+
"documented": true,
|
|
541
|
+
"title": "format",
|
|
542
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a dropdown menu tool in your WYSIWYG toolbar for structured text.\n\nSetting this key to `true` will enable a dropdown menu tool in your WYSIWYG toolbar for structured text. Valid values include for `p`, `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `pre`, `address`, and `div`. Include a space between each values, e.g. `format: p h1 h2`."
|
|
433
543
|
},
|
|
434
544
|
"type._editables.*.horizontalrule": {
|
|
435
|
-
"description": "
|
|
545
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a horizontal line.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a horizontal line.",
|
|
436
546
|
"default": false,
|
|
437
547
|
"type": "boolean",
|
|
438
|
-
"
|
|
548
|
+
"documented": true,
|
|
549
|
+
"title": "horizontalrule",
|
|
550
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a horizontal line.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a horizontal line."
|
|
439
551
|
},
|
|
440
552
|
"type._editables.*.image": {
|
|
441
|
-
"description": "
|
|
553
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert an image and enter alternative text and title text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert an image. Select an existing image, upload an image, or use an external link.",
|
|
442
554
|
"default": true,
|
|
443
555
|
"type": "boolean",
|
|
444
|
-
"
|
|
556
|
+
"documented": true,
|
|
557
|
+
"title": "image",
|
|
558
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert an image and enter alternative text and title text.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert an image. Select an existing image, upload an image, or use an external link."
|
|
445
559
|
},
|
|
446
560
|
"type._editables.*.indent": {
|
|
447
|
-
"description": "
|
|
561
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to increase the indentation of a list item in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to increase the indentation of a list item.",
|
|
448
562
|
"default": false,
|
|
449
563
|
"type": "boolean",
|
|
450
|
-
"
|
|
564
|
+
"documented": true,
|
|
565
|
+
"title": "indent",
|
|
566
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to increase the indentation of a list item in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to increase the indentation of a list item."
|
|
451
567
|
},
|
|
452
568
|
"type._editables.*.justify": {
|
|
453
|
-
"description": "
|
|
569
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to justify selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to justify selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file.",
|
|
454
570
|
"type": "string",
|
|
455
|
-
"
|
|
571
|
+
"documented": true,
|
|
572
|
+
"title": "justify",
|
|
573
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to justify selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to justify selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file."
|
|
456
574
|
},
|
|
457
575
|
"type._editables.*.left": {
|
|
458
|
-
"description": "
|
|
576
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to left align selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to left align selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file.",
|
|
459
577
|
"type": "string",
|
|
460
|
-
"
|
|
578
|
+
"documented": true,
|
|
579
|
+
"title": "left",
|
|
580
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to left align selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to left align selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file."
|
|
461
581
|
},
|
|
462
582
|
"type._editables.*.numberedlist": {
|
|
463
|
-
"description": "
|
|
583
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert an ordered list or convert selected text to an ordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert an ordered list or convert selected text to an ordered list.",
|
|
464
584
|
"default": true,
|
|
465
585
|
"type": "boolean",
|
|
466
|
-
"
|
|
586
|
+
"documented": true,
|
|
587
|
+
"title": "numberedlist",
|
|
588
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert an ordered list or convert selected text to an ordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert an ordered list or convert selected text to an ordered list."
|
|
467
589
|
},
|
|
468
590
|
"type._editables.*.outdent": {
|
|
469
|
-
"description": "
|
|
591
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to decrease the indentation of a list item in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to decrease the indentation of a list item.",
|
|
470
592
|
"default": false,
|
|
471
593
|
"type": "boolean",
|
|
472
|
-
"
|
|
594
|
+
"documented": true,
|
|
595
|
+
"title": "outdent",
|
|
596
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to decrease the indentation of a list item in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to decrease the indentation of a list item."
|
|
473
597
|
},
|
|
474
598
|
"type._editables.*.right": {
|
|
475
|
-
"description": "
|
|
599
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to right align selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to right align selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file.",
|
|
476
600
|
"type": "string",
|
|
477
|
-
"
|
|
601
|
+
"documented": true,
|
|
602
|
+
"title": "right",
|
|
603
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to right align selected text by toggling a class name for that text block.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to right align selected text. The value is the class name to align the text. The styles for this class must be defined in the `styles` file."
|
|
478
604
|
},
|
|
479
605
|
"type._editables.*.snippet": {
|
|
480
|
-
"description": "
|
|
606
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a [Snippet](https://cloudcannon.com/documentation/articles/what-is-a-snippet/), if any are available.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a Snippet.",
|
|
481
607
|
"default": true,
|
|
482
608
|
"type": "boolean",
|
|
483
|
-
"
|
|
609
|
+
"documented": true,
|
|
610
|
+
"title": "snippet",
|
|
611
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a [Snippet](https://cloudcannon.com/documentation/articles/what-is-a-snippet/), if any are available.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a Snippet."
|
|
484
612
|
},
|
|
485
613
|
"type._editables.*.styles": {
|
|
486
|
-
"description": "
|
|
614
|
+
"description": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\nSetting this key to `true` will enable a dropdown menu in your WYSIWYG toolbar to apply a style to selected text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) for the CSS file containing styles.",
|
|
487
615
|
"type": "string",
|
|
488
|
-
"
|
|
616
|
+
"documented": true,
|
|
617
|
+
"title": "styles",
|
|
618
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a dropdown menu in your WYSIWYG toolbar to apply a style to selected text.\n\nSetting this key to `true` will enable a dropdown menu in your WYSIWYG toolbar to apply a style to selected text. Styles are the combination of an element and class name. The value for this option is the path (either source or build output) for the CSS file containing styles."
|
|
489
619
|
},
|
|
490
620
|
"type._editables.*.table": {
|
|
491
|
-
"description": "
|
|
621
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a table.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a table. Further table options are available from the table context menu in the rich text editor.",
|
|
492
622
|
"default": false,
|
|
493
623
|
"type": "boolean",
|
|
494
|
-
"
|
|
624
|
+
"documented": true,
|
|
625
|
+
"title": "table",
|
|
626
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to insert a table.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to insert a table. Further table options are available from the table context menu in the rich text editor."
|
|
495
627
|
},
|
|
496
628
|
"type._editables.*.join_above": {
|
|
497
|
-
"description": "
|
|
629
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to merge a list item with the item above it in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to merge a list item with the item above it.",
|
|
498
630
|
"default": false,
|
|
499
631
|
"type": "boolean",
|
|
500
|
-
"
|
|
632
|
+
"documented": true,
|
|
633
|
+
"title": "join_above",
|
|
634
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to merge a list item with the item above it in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to merge a list item with the item above it."
|
|
501
635
|
},
|
|
502
636
|
"type._editables.*.join_below": {
|
|
503
|
-
"description": "
|
|
637
|
+
"description": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to merge a list item with the item below it in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to merge a list item with the item below it.",
|
|
504
638
|
"default": false,
|
|
505
639
|
"type": "boolean",
|
|
506
|
-
"
|
|
640
|
+
"documented": true,
|
|
641
|
+
"title": "join_below",
|
|
642
|
+
"markdownDescription": "This key toggles whether CloudCannon will display a tool in your WYSIWYG toolbar to merge a list item with the item below it in an ordered or unordered list.\n\nSetting this key to `true` will enable a tool in your WYSIWYG toolbar to merge a list item with the item below it."
|
|
507
643
|
},
|
|
508
644
|
"BlockEditable": {
|
|
509
645
|
"title": "Block Editable",
|
|
510
|
-
"description": "
|
|
646
|
+
"description": "This key defines input options for block Editable Regions.",
|
|
511
647
|
"type": "object",
|
|
512
648
|
"properties": {
|
|
513
649
|
"mime_type": {
|
|
@@ -542,7 +678,9 @@
|
|
|
542
678
|
{
|
|
543
679
|
"$ref": "#/definitions/type.paths"
|
|
544
680
|
}
|
|
545
|
-
]
|
|
681
|
+
],
|
|
682
|
+
"documented": false,
|
|
683
|
+
"title": "paths"
|
|
546
684
|
},
|
|
547
685
|
"bold": {
|
|
548
686
|
"$ref": "#/definitions/type._editables.*.bold"
|
|
@@ -648,11 +786,12 @@
|
|
|
648
786
|
}
|
|
649
787
|
},
|
|
650
788
|
"additionalProperties": false,
|
|
651
|
-
"
|
|
789
|
+
"documented": true,
|
|
790
|
+
"markdownDescription": "This key defines input options for block Editable Regions."
|
|
652
791
|
},
|
|
653
792
|
"LinkEditable": {
|
|
654
793
|
"title": "Link Editable",
|
|
655
|
-
"description": "
|
|
794
|
+
"description": "This key defines input options for link Editable Regions.",
|
|
656
795
|
"type": "object",
|
|
657
796
|
"properties": {
|
|
658
797
|
"paths": {
|
|
@@ -660,15 +799,18 @@
|
|
|
660
799
|
{
|
|
661
800
|
"$ref": "#/definitions/type.paths"
|
|
662
801
|
}
|
|
663
|
-
]
|
|
802
|
+
],
|
|
803
|
+
"documented": false,
|
|
804
|
+
"title": "paths"
|
|
664
805
|
}
|
|
665
806
|
},
|
|
666
807
|
"additionalProperties": false,
|
|
667
|
-
"
|
|
808
|
+
"documented": true,
|
|
809
|
+
"markdownDescription": "This key defines input options for link Editable Regions."
|
|
668
810
|
},
|
|
669
811
|
"ImageEditable": {
|
|
670
812
|
"title": "Image Editable",
|
|
671
|
-
"description": "
|
|
813
|
+
"description": "This key defines input options for image Editable Regions.",
|
|
672
814
|
"type": "object",
|
|
673
815
|
"properties": {
|
|
674
816
|
"mime_type": {
|
|
@@ -703,15 +845,18 @@
|
|
|
703
845
|
{
|
|
704
846
|
"$ref": "#/definitions/type.paths"
|
|
705
847
|
}
|
|
706
|
-
]
|
|
848
|
+
],
|
|
849
|
+
"documented": false,
|
|
850
|
+
"title": "paths"
|
|
707
851
|
}
|
|
708
852
|
},
|
|
709
853
|
"additionalProperties": false,
|
|
710
|
-
"
|
|
854
|
+
"documented": true,
|
|
855
|
+
"markdownDescription": "This key defines input options for image Editable Regions."
|
|
711
856
|
},
|
|
712
857
|
"TextEditable": {
|
|
713
858
|
"title": "Text Editable",
|
|
714
|
-
"description": "
|
|
859
|
+
"description": "This key defines input options for text Editable Regions.",
|
|
715
860
|
"type": "object",
|
|
716
861
|
"properties": {
|
|
717
862
|
"paths": {
|
|
@@ -719,7 +864,9 @@
|
|
|
719
864
|
{
|
|
720
865
|
"$ref": "#/definitions/type.paths"
|
|
721
866
|
}
|
|
722
|
-
]
|
|
867
|
+
],
|
|
868
|
+
"documented": false,
|
|
869
|
+
"title": "paths"
|
|
723
870
|
},
|
|
724
871
|
"bold": {
|
|
725
872
|
"$ref": "#/definitions/type._editables.*.bold"
|
|
@@ -762,7 +909,10 @@
|
|
|
762
909
|
}
|
|
763
910
|
},
|
|
764
911
|
"additionalProperties": false,
|
|
765
|
-
"
|
|
912
|
+
"documented": true,
|
|
913
|
+
"markdownDescription": "This key defines input options for text Editable Regions."
|
|
766
914
|
}
|
|
767
|
-
}
|
|
915
|
+
},
|
|
916
|
+
"documented": false,
|
|
917
|
+
"markdownDescription": "Configuration for editable regions in the Visual Editor, including content, block, link, image, and text editing options."
|
|
768
918
|
}
|