@cloudcannon/configuration-types 0.0.50 → 0.0.52

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.
@@ -671,7 +671,7 @@
671
671
  "collections_config.*.path": {
672
672
  "gid": "collections_config.*.path",
673
673
  "title": "",
674
- "description": "This key defines the folder path for the collection key in which it is nested.\n\nThe value for this key is relative to your [Site source](/documentation/articles/configuration-file-reference/#source).\n\nEach Collection must have a unique path.",
674
+ "description": "This key defines the folder path for the collection key in which it is nested.\n\nThe value for this key is relative to your [Site source](/documentation/developer-reference/configuration-file/source/).\n\nEach Collection must have a unique path.",
675
675
  "examples": [
676
676
  {
677
677
  "description": "In this example, the files for the `blog` Collection are located in the `content/blog` folder.",
@@ -686,7 +686,7 @@
686
686
  "gid": "collections_config.*.path",
687
687
  "url": "/configuration-file/collections_config/*/path/",
688
688
  "title": "",
689
- "description": "This key defines the folder path for the collection key in which it is nested.\n\nThe value for this key is relative to your [Site source](/documentation/articles/configuration-file-reference/#source).\n\nEach Collection must have a unique path.",
689
+ "description": "This key defines the folder path for the collection key in which it is nested.\n\nThe value for this key is relative to your [Site source](/documentation/developer-reference/configuration-file/source/).\n\nEach Collection must have a unique path.",
690
690
  "examples": [
691
691
  {
692
692
  "description": "In this example, the files for the `blog` Collection are located in the `content/blog` folder.",
@@ -711,7 +711,7 @@
711
711
  "collections_config.*.glob": {
712
712
  "gid": "collections_config.*.glob",
713
713
  "title": "",
714
- "description": "This key defines globs which filter the files visible in the *Collection browser* for a given Collection.\n\nValues in this array are relative to the Collection [path](/documentation/articles/collections-reference/#path).\n\nGlobs can be positive (e.g. `*.yml`), or negative (e.g. `!**/*.json`).\n\nFiles are included in a Collection if they match any positive globs and do not match any negative globs.\n\nIf you do not define any positive globs, CloudCannon will include all non-developer files in a Collection unless they match a negative\nglob.\n\n> For more information about developer files, please read our documentation on the [include\\_developer\\_files](/documentation/articles/collections-reference/#include_developer_files) key.\n\nDefining a negative glob for a Collection does not remove a file from the associated Collection folder in your Git repository.\n\nSimilarly, defining a positive glob for a file in a folder outside your Collection path does not move the file.",
714
+ "description": "This key defines globs which filter the files visible in the *Collection browser* for a given Collection.\n\nGlobs can be positive (e.g. `*.yml`), or negative (e.g. `!**/*.json`).\n\nFiles are included in a Collection if they match any positive globs and do not match any negative globs.\n\nIf you do not define any positive globs, CloudCannon will include all non-developer files in a Collection unless they match a negative\nglob.\n\nDefining a negative glob for a Collection does not remove a file from the associated Collection folder in your Git repository.\n\nSimilarly, defining a positive glob for a file in a folder outside your Collection path does not move the file.",
715
715
  "examples": [
716
716
  {
717
717
  "description": "In this example, the *Collection browser* will show all files in the `data` folder except for the `secret.yml` file.",
@@ -739,7 +739,7 @@
739
739
  "gid": "collections_config.*.glob",
740
740
  "url": "/configuration-file/collections_config/*/glob/",
741
741
  "title": "",
742
- "description": "This key defines globs which filter the files visible in the *Collection browser* for a given Collection.\n\nValues in this array are relative to the Collection [path](/documentation/articles/collections-reference/#path).\n\nGlobs can be positive (e.g. `*.yml`), or negative (e.g. `!**/*.json`).\n\nFiles are included in a Collection if they match any positive globs and do not match any negative globs.\n\nIf you do not define any positive globs, CloudCannon will include all non-developer files in a Collection unless they match a negative\nglob.\n\n> For more information about developer files, please read our documentation on the [include\\_developer\\_files](/documentation/articles/collections-reference/#include_developer_files) key.\n\nDefining a negative glob for a Collection does not remove a file from the associated Collection folder in your Git repository.\n\nSimilarly, defining a positive glob for a file in a folder outside your Collection path does not move the file.",
742
+ "description": "This key defines globs which filter the files visible in the *Collection browser* for a given Collection.\n\nGlobs can be positive (e.g. `*.yml`), or negative (e.g. `!**/*.json`).\n\nFiles are included in a Collection if they match any positive globs and do not match any negative globs.\n\nIf you do not define any positive globs, CloudCannon will include all non-developer files in a Collection unless they match a negative\nglob.\n\nDefining a negative glob for a Collection does not remove a file from the associated Collection folder in your Git repository.\n\nSimilarly, defining a positive glob for a file in a folder outside your Collection path does not move the file.",
743
743
  "examples": [
744
744
  {
745
745
  "description": "In this example, the *Collection browser* will show all files in the `data` folder except for the `secret.yml` file.",
@@ -990,7 +990,7 @@
990
990
  "collections_config.*.include_developer_files": {
991
991
  "gid": "collections_config.*.include_developer_files",
992
992
  "title": "",
993
- "description": "This key toggles whether CloudCannon removes developer files from your *Collection browser*. CloudCannon excludes files that probably shouldn't be edited in a CMS from your *Collection browser*, for example files like `README.md` or\n`package.json`. CloudCannon excludes these files even if you have configured globs to allow them.\n\nSetting this key to `true` will allow CloudCannon to show developer files,\nassuming they are not filtered out by any configured\n[globs](/documentation/articles/collections-reference/#glob).",
993
+ "description": "This key toggles whether CloudCannon removes developer files from your *Collection browser*. CloudCannon excludes files that probably shouldn't be edited in a CMS from your *Collection browser*, for example files like `README.md` or\n`package.json`. CloudCannon excludes these files even if you have configured globs to allow them.\n\nSetting this key to `true` will allow CloudCannon to show developer files,\nassuming they are not filtered out by any configured\n[globs](/documentation/developer-reference/configuration-file/collections_config/*/glob/). ",
994
994
  "examples": [
995
995
  {
996
996
  "description": "In this example, we want to see developer files in the *Collection browser* for the `data` Collection.",
@@ -1006,7 +1006,7 @@
1006
1006
  "gid": "collections_config.*.include_developer_files",
1007
1007
  "url": "/configuration-file/collections_config/*/include_developer_files/",
1008
1008
  "title": "",
1009
- "description": "This key toggles whether CloudCannon removes developer files from your *Collection browser*. CloudCannon excludes files that probably shouldn't be edited in a CMS from your *Collection browser*, for example files like `README.md` or\n`package.json`. CloudCannon excludes these files even if you have configured globs to allow them.\n\nSetting this key to `true` will allow CloudCannon to show developer files,\nassuming they are not filtered out by any configured\n[globs](/documentation/articles/collections-reference/#glob).",
1009
+ "description": "This key toggles whether CloudCannon removes developer files from your *Collection browser*. CloudCannon excludes files that probably shouldn't be edited in a CMS from your *Collection browser*, for example files like `README.md` or\n`package.json`. CloudCannon excludes these files even if you have configured globs to allow them.\n\nSetting this key to `true` will allow CloudCannon to show developer files,\nassuming they are not filtered out by any configured\n[globs](/documentation/developer-reference/configuration-file/collections_config/*/glob/). ",
1010
1010
  "examples": [
1011
1011
  {
1012
1012
  "description": "In this example, we want to see developer files in the *Collection browser* for the `data` Collection.",
@@ -8858,7 +8858,7 @@
8858
8858
  "collections_config.*.add_options": {
8859
8859
  "gid": "collections_config.*.add_options",
8860
8860
  "title": "",
8861
- "description": "This key defines the options available in the *\\+ Add* button dropdown at the top right of your *Collection browser*.\n\nConfiguring add options for a Collection will remove CloudCannon's default \"Add a file\" option from the *\\+ Add* button dropdown.\n\nAdditionally, any Schemas you have configured for a Collection will also appear in the *\\+ Add* dropdown.\n\nFor more information on these options, please read our reference documentation on [disable\\_add](/documentation/articles/collections-reference/#disable_add), [disable\\_add\\_folder](/documentation/articles/collections-reference/#disable_add_folder), and [schemas](/documentation/articles/schemas-reference/#schemas).",
8861
+ "description": "This key defines the options available in the *\\+ Add* button dropdown at the top right of your *Collection browser*.\n\nConfiguring add options for a Collection will remove CloudCannon's default \"Add a file\" option from the *\\+ Add* button dropdown.\n\nAdditionally, any Schemas you have configured for a Collection will also appear in the *\\+ Add* dropdown.",
8862
8862
  "examples": [
8863
8863
  {
8864
8864
  "description": "In this example, we have configured two standard add options for the `people` Collection. The first option uses the `employee` Schema, and the second option uses the `contractor` Schema and opens files in the [Data Editor](/documentation/articles/what-is-the-data-editor/).",
@@ -8880,7 +8880,7 @@
8880
8880
  "gid": "collections_config.*.add_options",
8881
8881
  "url": "/configuration-file/collections_config/*/add_options/",
8882
8882
  "title": "",
8883
- "description": "This key defines the options available in the *\\+ Add* button dropdown at the top right of your *Collection browser*.\n\nConfiguring add options for a Collection will remove CloudCannon's default \"Add a file\" option from the *\\+ Add* button dropdown.\n\nAdditionally, any Schemas you have configured for a Collection will also appear in the *\\+ Add* dropdown.\n\nFor more information on these options, please read our reference documentation on [disable\\_add](/documentation/articles/collections-reference/#disable_add), [disable\\_add\\_folder](/documentation/articles/collections-reference/#disable_add_folder), and [schemas](/documentation/articles/schemas-reference/#schemas).",
8883
+ "description": "This key defines the options available in the *\\+ Add* button dropdown at the top right of your *Collection browser*.\n\nConfiguring add options for a Collection will remove CloudCannon's default \"Add a file\" option from the *\\+ Add* button dropdown.\n\nAdditionally, any Schemas you have configured for a Collection will also appear in the *\\+ Add* dropdown.",
8884
8884
  "examples": [
8885
8885
  {
8886
8886
  "description": "In this example, we have configured two standard add options for the `people` Collection. The first option uses the `employee` Schema, and the second option uses the `contractor` Schema and opens files in the [Data Editor](/documentation/articles/what-is-the-data-editor/).",
@@ -12753,7 +12753,7 @@
12753
12753
  "collections_config.*.add_options.[*].(add-option).base_path": {
12754
12754
  "gid": "collections_config.*.add_options.[*].(add-option).base_path",
12755
12755
  "title": "",
12756
- "description": "This key defines a path for files created using an option in the *\\+ Add* button dropdown.\n\nThis path overrides the path for the current Collection and subfolder open in the *Collection browser*.\n\nThis key is useful if you need to specify a specific subfolder within a Collection.\n\nThe value for this key is relative to your Collection [path](/documentation/articles/collections-reference/#path).",
12756
+ "description": "This key defines a path for files created using an option in the *\\+ Add* button dropdown.\n\nThis path overrides the path for the current Collection and subfolder open in the *Collection browser*.\n\nThis key is useful if you need to specify a specific subfolder within a Collection.",
12757
12757
  "examples": [
12758
12758
  {
12759
12759
  "description": "In this example, we want team members in the `_posts` Collection to create new files in the`blog` subfolder of the `_drafts` Collection rather than the current *Collection browser* they have open. By configuring the `base_path` value to `/../_drafts/blog`, new files will be created in a different Collection subfolder (i.e., `_drafts`) when a team member selects this option from the *\\+ Add* button dropdown.",
@@ -12768,7 +12768,7 @@
12768
12768
  "gid": "collections_config.*.add_options.[*].(add-option).base_path",
12769
12769
  "url": "/configuration-file/collections_config/*/add_options/[*]/(add-option)/base_path/",
12770
12770
  "title": "",
12771
- "description": "This key defines a path for files created using an option in the *\\+ Add* button dropdown.\n\nThis path overrides the path for the current Collection and subfolder open in the *Collection browser*.\n\nThis key is useful if you need to specify a specific subfolder within a Collection.\n\nThe value for this key is relative to your Collection [path](/documentation/articles/collections-reference/#path).",
12771
+ "description": "This key defines a path for files created using an option in the *\\+ Add* button dropdown.\n\nThis path overrides the path for the current Collection and subfolder open in the *Collection browser*.\n\nThis key is useful if you need to specify a specific subfolder within a Collection.",
12772
12772
  "examples": [
12773
12773
  {
12774
12774
  "description": "In this example, we want team members in the `_posts` Collection to create new files in the`blog` subfolder of the `_drafts` Collection rather than the current *Collection browser* they have open. By configuring the `base_path` value to `/../_drafts/blog`, new files will be created in a different Collection subfolder (i.e., `_drafts`) when a team member selects this option from the *\\+ Add* button dropdown.",
@@ -36742,7 +36742,7 @@
36742
36742
  "type._structures_from_glob": {
36743
36743
  "gid": "type._structures_from_glob",
36744
36744
  "title": "",
36745
- "description": "This key defines globs that filter which files CloudCannon should use for *Structure* configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](/documentation/articles/configuration-file-reference/#values_from_glob) for defining individual\n*Structure* values in a split *Configuration File*.\n\nThis key has no default.",
36745
+ "description": "This key defines globs that filter which files CloudCannon should use for *Structure* configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](/documentation/developer-reference/configuration-file/types/structure/values_from_glob/) for defining individual\n*Structure* values in a split *Configuration File*.\n\nThis key has no default.",
36746
36746
  "examples": [
36747
36747
  {
36748
36748
  "description": "In this example, we have several *Structure Configuration Files* in the `.cloudcannon/structures/` folder. The value of the `_structures_from_glob` key tells CloudCannon to use the `staffMembers.cloudcannon.structures.yml` file in that folder.",
@@ -36764,7 +36764,7 @@
36764
36764
  "gid": "type._structures_from_glob",
36765
36765
  "url": "/configuration-file/types/_structures_from_glob/",
36766
36766
  "title": "",
36767
- "description": "This key defines globs that filter which files CloudCannon should use for *Structure* configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](/documentation/articles/configuration-file-reference/#values_from_glob) for defining individual\n*Structure* values in a split *Configuration File*.\n\nThis key has no default.",
36767
+ "description": "This key defines globs that filter which files CloudCannon should use for *Structure* configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structures.yml`.\n\nYou can use this key anywhere you would use the `_structures` key in the configuration cascade.\n\nPlease see our documentation on [values_from_glob](/documentation/developer-reference/configuration-file/types/structure/values_from_glob/) for defining individual\n*Structure* values in a split *Configuration File*.\n\nThis key has no default.",
36768
36768
  "examples": [
36769
36769
  {
36770
36770
  "description": "In this example, we have several *Structure Configuration Files* in the `.cloudcannon/structures/` folder. The value of the `_structures_from_glob` key tells CloudCannon to use the `staffMembers.cloudcannon.structures.yml` file in that folder.",
@@ -41146,7 +41146,7 @@
41146
41146
  "type.structure.values_from_glob": {
41147
41147
  "gid": "type.structure.values_from_glob",
41148
41148
  "title": "",
41149
- "description": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](/documentation/articles/configuration-file-reference/#_structures_from_glob) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.",
41149
+ "description": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](/documentation/developer-reference/configuration-file/types/_structures_from_glob/) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.",
41150
41150
  "examples": [
41151
41151
  {
41152
41152
  "description": "In this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure_value.yml` in the `/.cloudcannon/structures/` folder.",
@@ -41168,7 +41168,7 @@
41168
41168
  "gid": "type.structure.values_from_glob",
41169
41169
  "url": "/configuration-file/types/structure/values_from_glob/",
41170
41170
  "title": "",
41171
- "description": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](/documentation/articles/configuration-file-reference/#_structures_from_glob) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.",
41171
+ "description": "This key defines globs that filter which files CloudCannon should use for *Structure* value configuration.\n\nValues in this array are relative to the root of your repository (i.e., `/`, not the value of `source`) and must end in the file extension\n`.cloudcannon.structure-value.yml` (note the singular form of \"value\").\n\nYou can use this key anywhere you would use the `_structures.*.values` key.\n\nPlease see our documentation on [structures_from_glob](/documentation/developer-reference/configuration-file/types/_structures_from_glob/) for defining a\n*Structure* in a split *Configuration File*.\n\nThis key has no default.",
41172
41172
  "examples": [
41173
41173
  {
41174
41174
  "description": "In this example, the `staff` Array Input uses inline *Structure* values from the main *Configuration File* and also references another value from the `boardMember.cloudcannon.structure_value.yml` in the `/.cloudcannon/structures/` folder.",
@@ -50376,7 +50376,9 @@
50376
50376
  "appears_in": [
50377
50377
  "type.snippet.params.*.(argument-list-parser-config).options.models",
50378
50378
  "type.snippet.params.*.(argument-parser-config).options",
50379
- "type.snippet.params.*.(key-value-list-parser-config).options.models"
50379
+ "type.snippet.params.*.(key-value-list-parser-config).options.models",
50380
+ "type.snippet-definition-value",
50381
+ "type.snippet-definition-value.(parser-model-array)"
50380
50382
  ],
50381
50383
  "properties": {
50382
50384
  "source_key": {
@@ -50908,7 +50910,8 @@
50908
50910
  "appears_in": [
50909
50911
  "type.snippet.params.*.(argument-list-parser-config).options",
50910
50912
  "type.snippet.params.*.(argument-parser-config).options",
50911
- "type.snippet.params.*.(key-value-list-parser-config).options"
50913
+ "type.snippet.params.*.(key-value-list-parser-config).options",
50914
+ "type.snippet-definition-value"
50912
50915
  ],
50913
50916
  "properties": {
50914
50917
  "root_boundary": {
@@ -57015,19 +57018,64 @@
57015
57018
  "type._snippets_definitions": {
57016
57019
  "gid": "type._snippets_definitions",
57017
57020
  "title": "",
57018
- "description": "This key defines extended options used when creating more complex custom snippets.",
57021
+ "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using `{ ref: \"key\" }` for direct replacement or `{ spread_ref: \"key\" }` for spreading arrays/objects. Common definition types include parser formats, argument models, select option lists, and simple string values like shortcode names.",
57022
+ "examples": [
57023
+ {
57024
+ "description": "Define reusable values like shortcode names, argument models, and parser formats that can be referenced in snippet templates.",
57025
+ "language": "yaml",
57026
+ "code": "_snippets_definitions:\n # Simple string value for the shortcode name\n shortcode_name: \"highlight\"\n content_key: \"content\"\n\n # Array of argument models for positional arguments\n positional_args:\n - editor_key: \"language\"\n type: \"string\"\n - editor_key: \"linenos\"\n type: \"boolean\"\n optional: true\n default: false\n\n # Parser format configuration\n custom_format:\n root_pair_delimiter:\n - \" \"\n root_value_delimiter: \"=\"\n string_boundary:\n - '\"'\n - \"'\"\n - \"\"\n allow_booleans: true\n allow_numbers: true",
57027
+ "annotations": [],
57028
+ "source": "/cloudcannon.config.yml"
57029
+ },
57030
+ {
57031
+ "description": "Reference definitions in snippet templates using `{ ref: \"key\" }` syntax. This allows you to reuse common configurations across multiple snippets.",
57032
+ "language": "yaml",
57033
+ "code": "_snippets_definitions:\n shortcode_name: \"figure\"\n named_args:\n - editor_key: \"src\"\n type: \"string\"\n - editor_key: \"alt\"\n type: \"string\"\n optional: true\n\n_snippets_templates:\n my_shortcode_template:\n snippet: \"{{< [[name]] [[args]] >}}\"\n params:\n name:\n parser: \"literal\"\n options:\n literal:\n ref: \"shortcode_name\"\n args:\n parser: \"key_values\"\n options:\n models:\n ref: \"named_args\"\n\n_snippets:\n figure:\n template: \"my_shortcode_template\"\n definitions:\n shortcode_name: \"figure\"\n named_args:\n - editor_key: \"src\"\n type: \"string\"\n - editor_key: \"alt\"\n type: \"string\"",
57034
+ "annotations": [],
57035
+ "source": "/cloudcannon.config.yml"
57036
+ },
57037
+ {
57038
+ "description": "Define a list of select options for use in snippet inputs, such as a list of programming languages for a code highlighting snippet.",
57039
+ "language": "yaml",
57040
+ "code": "_snippets_definitions:\n languages:\n - name: \"JavaScript\"\n value: \"js\"\n - name: \"Python\"\n value: \"python\"\n - name: \"Ruby\"\n value: \"ruby\"\n - name: \"HTML\"\n value: \"html\"\n - name: \"CSS\"\n value: \"css\"",
57041
+ "annotations": [],
57042
+ "source": "/cloudcannon.config.yml"
57043
+ }
57044
+ ],
57019
57045
  "type": "object",
57020
57046
  "documentation": {
57021
57047
  "gid": "type._snippets_definitions",
57022
57048
  "url": "/configuration-file/types/_snippets_definitions/",
57023
57049
  "title": "",
57024
- "description": "This key defines extended options used when creating more complex custom snippets.",
57025
- "examples": [],
57026
- "show_in_navigation": true
57050
+ "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using `{ ref: \"key\" }` for direct replacement or `{ spread_ref: \"key\" }` for spreading arrays/objects. Common definition types include parser formats, argument models, select option lists, and simple string values like shortcode names.",
57051
+ "examples": [
57052
+ {
57053
+ "description": "Define reusable values like shortcode names, argument models, and parser formats that can be referenced in snippet templates.",
57054
+ "language": "yaml",
57055
+ "code": "_snippets_definitions:\n # Simple string value for the shortcode name\n shortcode_name: \"highlight\"\n content_key: \"content\"\n\n # Array of argument models for positional arguments\n positional_args:\n - editor_key: \"language\"\n type: \"string\"\n - editor_key: \"linenos\"\n type: \"boolean\"\n optional: true\n default: false\n\n # Parser format configuration\n custom_format:\n root_pair_delimiter:\n - \" \"\n root_value_delimiter: \"=\"\n string_boundary:\n - '\"'\n - \"'\"\n - \"\"\n allow_booleans: true\n allow_numbers: true",
57056
+ "annotations": [],
57057
+ "source": "/cloudcannon.config.yml"
57058
+ },
57059
+ {
57060
+ "description": "Reference definitions in snippet templates using `{ ref: \"key\" }` syntax. This allows you to reuse common configurations across multiple snippets.",
57061
+ "language": "yaml",
57062
+ "code": "_snippets_definitions:\n shortcode_name: \"figure\"\n named_args:\n - editor_key: \"src\"\n type: \"string\"\n - editor_key: \"alt\"\n type: \"string\"\n optional: true\n\n_snippets_templates:\n my_shortcode_template:\n snippet: \"{{< [[name]] [[args]] >}}\"\n params:\n name:\n parser: \"literal\"\n options:\n literal:\n ref: \"shortcode_name\"\n args:\n parser: \"key_values\"\n options:\n models:\n ref: \"named_args\"\n\n_snippets:\n figure:\n template: \"my_shortcode_template\"\n definitions:\n shortcode_name: \"figure\"\n named_args:\n - editor_key: \"src\"\n type: \"string\"\n - editor_key: \"alt\"\n type: \"string\"",
57063
+ "annotations": [],
57064
+ "source": "/cloudcannon.config.yml"
57065
+ },
57066
+ {
57067
+ "description": "Define a list of select options for use in snippet inputs, such as a list of programming languages for a code highlighting snippet.",
57068
+ "language": "yaml",
57069
+ "code": "_snippets_definitions:\n languages:\n - name: \"JavaScript\"\n value: \"js\"\n - name: \"Python\"\n value: \"python\"\n - name: \"Ruby\"\n value: \"ruby\"\n - name: \"HTML\"\n value: \"html\"\n - name: \"CSS\"\n value: \"css\"",
57070
+ "annotations": [],
57071
+ "source": "/cloudcannon.config.yml"
57072
+ }
57073
+ ],
57074
+ "show_in_navigation": false
57027
57075
  },
57028
57076
  "developer_documentation": {
57029
57077
  "title": "Snippets Definitions",
57030
- "description": "Extended option used when creating more complex custom snippets."
57078
+ "description": "A record of reusable values that can be referenced in snippet templates. Values are substituted using { ref: \"key\" } for direct replacement or { spread_ref: \"key\" } for spreading arrays/objects."
57031
57079
  },
57032
57080
  "url": "/configuration-file/types/_snippets_definitions/",
57033
57081
  "required": false,
@@ -57038,10 +57086,395 @@
57038
57086
  ],
57039
57087
  "additionalProperties": [
57040
57088
  {
57041
- "type": "unknown"
57089
+ "gid": "type.snippet-definition-value"
57090
+ }
57091
+ ]
57092
+ },
57093
+ "type.snippet-definition-value": {
57094
+ "gid": "type.snippet-definition-value",
57095
+ "title": "Snippet Definition Value",
57096
+ "description": "A reusable value that can be referenced in snippet templates via `{ ref: \"key\" }` or `{ spread_ref: \"key\" }`. Can be a string, number, boolean, parser format, parser model, array of models, or array of select options.",
57097
+ "documentation": {
57098
+ "gid": "type.snippet-definition-value",
57099
+ "url": "/configuration-file/types/snippet-definition-value/",
57100
+ "title": "Snippet Definition Value",
57101
+ "description": "A reusable value that can be referenced in snippet templates via `{ ref: \"key\" }` or `{ spread_ref: \"key\" }`. Can be a string, number, boolean, parser format, parser model, array of models, or array of select options.",
57102
+ "examples": [],
57103
+ "show_in_navigation": true
57104
+ },
57105
+ "developer_documentation": {
57106
+ "title": "Snippet Definition Value",
57107
+ "description": "A reusable value that can be referenced in snippet templates via { ref: \"key\" } or { spread_ref: \"key\" }."
57108
+ },
57109
+ "url": "/configuration-file/types/snippet-definition-value/",
57110
+ "required": false,
57111
+ "key": "snippet-definition-value",
57112
+ "full_key": "snippet-definition-value",
57113
+ "appears_in": [
57114
+ "type._snippets_definitions"
57115
+ ],
57116
+ "anyOf": [
57117
+ {
57118
+ "gid": "type.snippet-format"
57119
+ },
57120
+ {
57121
+ "gid": "type.snippet-model"
57122
+ },
57123
+ {
57124
+ "gid": "type.snippet-definition-value.(parser-model-array)"
57125
+ },
57126
+ {
57127
+ "gid": "type.snippet-definition-value.(select-values-array)"
57128
+ },
57129
+ {
57130
+ "gid": "type.snippet-definition-value.(string-value)"
57131
+ },
57132
+ {
57133
+ "gid": "type.snippet-definition-value.(number-value)"
57134
+ },
57135
+ {
57136
+ "gid": "type.snippet-definition-value.(boolean-value)"
57137
+ },
57138
+ {
57139
+ "gid": "type.snippet-definition-value.(string-array)"
57140
+ }
57141
+ ]
57142
+ },
57143
+ "type.snippet-definition-value.(parser-model-array)": {
57144
+ "gid": "type.snippet-definition-value.(parser-model-array)",
57145
+ "title": "Parser Model Array",
57146
+ "description": "An array of parser model configurations. Typically used for `positional_args` or `named_args` definitions that specify the arguments a snippet accepts. Each model defines an argument's editor key, type, default value, and whether it's optional.",
57147
+ "type": "array",
57148
+ "documentation": {
57149
+ "gid": "type.snippet-definition-value.(parser-model-array)",
57150
+ "url": "/configuration-file/types/snippet-definition-value/(parser-model-array)/",
57151
+ "title": "Parser Model Array",
57152
+ "description": "An array of parser model configurations. Typically used for `positional_args` or `named_args` definitions that specify the arguments a snippet accepts. Each model defines an argument's editor key, type, default value, and whether it's optional.",
57153
+ "examples": [],
57154
+ "show_in_navigation": false
57155
+ },
57156
+ "developer_documentation": {
57157
+ "title": "Parser Model Array",
57158
+ "description": "An array of model configurations, typically used for positional_args or named_args."
57159
+ },
57160
+ "url": "/configuration-file/types/snippet-definition-value/(parser-model-array)/",
57161
+ "required": false,
57162
+ "key": "snippet-definition-value(parser-model-array)",
57163
+ "full_key": "snippet-definition-value(parser-model-array)",
57164
+ "parent": "type.snippet-definition-value",
57165
+ "appears_in": [],
57166
+ "items": [
57167
+ {
57168
+ "gid": "type.snippet-model"
57169
+ }
57170
+ ]
57171
+ },
57172
+ "type.snippet-definition-value.(select-values-array)": {
57173
+ "gid": "type.snippet-definition-value.(select-values-array)",
57174
+ "title": "Select Values Array",
57175
+ "description": "An array of select option values. Commonly used for language lists in code highlighting snippets, where each option has a display name and a value. For example: `[{ name: \"JavaScript\", value: \"js\" }, { name: \"Python\", value: \"python\" }]`.",
57176
+ "type": "array",
57177
+ "documentation": {
57178
+ "gid": "type.snippet-definition-value.(select-values-array)",
57179
+ "url": "/configuration-file/types/snippet-definition-value/(select-values-array)/",
57180
+ "title": "Select Values Array",
57181
+ "description": "An array of select option values. Commonly used for language lists in code highlighting snippets, where each option has a display name and a value. For example: `[{ name: \"JavaScript\", value: \"js\" }, { name: \"Python\", value: \"python\" }]`.",
57182
+ "examples": [],
57183
+ "show_in_navigation": false
57184
+ },
57185
+ "developer_documentation": {
57186
+ "title": "Select Values Array",
57187
+ "description": "An array of select options, typically used for language lists."
57188
+ },
57189
+ "url": "/configuration-file/types/snippet-definition-value/(select-values-array)/",
57190
+ "required": false,
57191
+ "key": "snippet-definition-value(select-values-array)",
57192
+ "full_key": "snippet-definition-value(select-values-array)",
57193
+ "parent": "type.snippet-definition-value",
57194
+ "appears_in": [],
57195
+ "items": [
57196
+ {
57197
+ "gid": "type.snippet-definition-select-value"
57198
+ }
57199
+ ]
57200
+ },
57201
+ "type.snippet-definition-select-value": {
57202
+ "gid": "type.snippet-definition-select-value",
57203
+ "title": "Snippet Definition Select Value",
57204
+ "description": "A value option for select inputs, typically used in language lists. Contains a display name and the actual value to use.",
57205
+ "type": "object",
57206
+ "documentation": {
57207
+ "gid": "type.snippet-definition-select-value",
57208
+ "url": "/configuration-file/types/snippet-definition-select-value/",
57209
+ "title": "Snippet Definition Select Value",
57210
+ "description": "A value option for select inputs, typically used in language lists. Contains a display name and the actual value to use.",
57211
+ "examples": [],
57212
+ "show_in_navigation": true
57213
+ },
57214
+ "developer_documentation": {
57215
+ "title": "Snippet Definition Select Value",
57216
+ "description": "A value option for select inputs, typically used in language lists."
57217
+ },
57218
+ "url": "/configuration-file/types/snippet-definition-select-value/",
57219
+ "required": false,
57220
+ "key": "snippet-definition-select-value",
57221
+ "full_key": "snippet-definition-select-value",
57222
+ "appears_in": [
57223
+ "type.snippet-definition-value.(select-values-array)"
57224
+ ],
57225
+ "properties": {
57226
+ "name": {
57227
+ "gid": "type.snippet-definition-select-value.name"
57228
+ },
57229
+ "value": {
57230
+ "gid": "type.snippet-definition-select-value.value"
57231
+ }
57232
+ }
57233
+ },
57234
+ "type.snippet-definition-select-value.name": {
57235
+ "gid": "type.snippet-definition-select-value.name",
57236
+ "title": "",
57237
+ "description": "The display name shown to users when selecting this option. For example, \"JavaScript\" for a language with value \"js\".",
57238
+ "type": "string",
57239
+ "documentation": {
57240
+ "gid": "type.snippet-definition-select-value.name",
57241
+ "url": "/configuration-file/types/snippet-definition-select-value/name/",
57242
+ "title": "",
57243
+ "description": "The display name shown to users when selecting this option. For example, \"JavaScript\" for a language with value \"js\".",
57244
+ "examples": [],
57245
+ "show_in_navigation": false
57246
+ },
57247
+ "developer_documentation": {
57248
+ "description": "The display name for this option."
57249
+ },
57250
+ "url": "/configuration-file/types/snippet-definition-select-value/name/",
57251
+ "required": false,
57252
+ "key": "name",
57253
+ "full_key": "snippet-definition-select-value.name",
57254
+ "parent": "type.snippet-definition-select-value",
57255
+ "appears_in": []
57256
+ },
57257
+ "type.snippet-definition-select-value.value": {
57258
+ "gid": "type.snippet-definition-select-value.value",
57259
+ "title": "",
57260
+ "description": "The actual value used when this option is selected. Can be a string, number, or boolean. For example, \"js\" for JavaScript or 4 for an indentation level.",
57261
+ "documentation": {
57262
+ "gid": "type.snippet-definition-select-value.value",
57263
+ "url": "/configuration-file/types/snippet-definition-select-value/value/",
57264
+ "title": "",
57265
+ "description": "The actual value used when this option is selected. Can be a string, number, or boolean. For example, \"js\" for JavaScript or 4 for an indentation level.",
57266
+ "examples": [],
57267
+ "show_in_navigation": false
57268
+ },
57269
+ "developer_documentation": {
57270
+ "description": "The value for this option."
57271
+ },
57272
+ "url": "/configuration-file/types/snippet-definition-select-value/value/",
57273
+ "required": true,
57274
+ "key": "value",
57275
+ "full_key": "snippet-definition-select-value.value",
57276
+ "parent": "type.snippet-definition-select-value",
57277
+ "appears_in": [],
57278
+ "anyOf": [
57279
+ {
57280
+ "gid": "type.snippet-definition-select-value.value.(string)"
57281
+ },
57282
+ {
57283
+ "gid": "type.snippet-definition-select-value.value.(number)"
57284
+ },
57285
+ {
57286
+ "gid": "type.snippet-definition-select-value.value.(boolean)"
57287
+ }
57288
+ ]
57289
+ },
57290
+ "type.snippet-definition-select-value.value.(string)": {
57291
+ "gid": "type.snippet-definition-select-value.value.(string)",
57292
+ "title": "String Select Value",
57293
+ "type": "string",
57294
+ "documentation": {
57295
+ "gid": "type.snippet-definition-select-value.value.(string)",
57296
+ "url": "/configuration-file/types/snippet-definition-select-value/value/(string)/",
57297
+ "title": "String Select Value",
57298
+ "description": "",
57299
+ "examples": [],
57300
+ "show_in_navigation": false
57301
+ },
57302
+ "developer_documentation": {
57303
+ "title": "String"
57304
+ },
57305
+ "url": "/configuration-file/types/snippet-definition-select-value/value/(string)/",
57306
+ "required": false,
57307
+ "key": "value(string)",
57308
+ "full_key": "snippet-definition-select-value.value(string)",
57309
+ "parent": "type.snippet-definition-select-value.value",
57310
+ "appears_in": []
57311
+ },
57312
+ "type.snippet-definition-select-value.value.(number)": {
57313
+ "gid": "type.snippet-definition-select-value.value.(number)",
57314
+ "title": "Number Select Value",
57315
+ "type": "number",
57316
+ "documentation": {
57317
+ "gid": "type.snippet-definition-select-value.value.(number)",
57318
+ "url": "/configuration-file/types/snippet-definition-select-value/value/(number)/",
57319
+ "title": "Number Select Value",
57320
+ "description": "",
57321
+ "examples": [],
57322
+ "show_in_navigation": false
57323
+ },
57324
+ "developer_documentation": {
57325
+ "title": "Number"
57326
+ },
57327
+ "url": "/configuration-file/types/snippet-definition-select-value/value/(number)/",
57328
+ "required": false,
57329
+ "key": "value(number)",
57330
+ "full_key": "snippet-definition-select-value.value(number)",
57331
+ "parent": "type.snippet-definition-select-value.value",
57332
+ "appears_in": []
57333
+ },
57334
+ "type.snippet-definition-select-value.value.(boolean)": {
57335
+ "gid": "type.snippet-definition-select-value.value.(boolean)",
57336
+ "title": "Boolean Select Value",
57337
+ "type": "boolean",
57338
+ "documentation": {
57339
+ "gid": "type.snippet-definition-select-value.value.(boolean)",
57340
+ "url": "/configuration-file/types/snippet-definition-select-value/value/(boolean)/",
57341
+ "title": "Boolean Select Value",
57342
+ "description": "",
57343
+ "examples": [],
57344
+ "show_in_navigation": false
57345
+ },
57346
+ "developer_documentation": {
57347
+ "title": "Boolean"
57348
+ },
57349
+ "url": "/configuration-file/types/snippet-definition-select-value/value/(boolean)/",
57350
+ "required": false,
57351
+ "key": "value(boolean)",
57352
+ "full_key": "snippet-definition-select-value.value(boolean)",
57353
+ "parent": "type.snippet-definition-select-value.value",
57354
+ "appears_in": []
57355
+ },
57356
+ "type.snippet-definition-value.(string-value)": {
57357
+ "gid": "type.snippet-definition-value.(string-value)",
57358
+ "title": "String Value",
57359
+ "description": "A string value definition. Commonly used for `shortcode_name`, `tag_name`, `content_key`, `include_name`, and similar definitions that identify snippet components by name.",
57360
+ "type": "string",
57361
+ "documentation": {
57362
+ "gid": "type.snippet-definition-value.(string-value)",
57363
+ "url": "/configuration-file/types/snippet-definition-value/(string-value)/",
57364
+ "title": "String Value",
57365
+ "description": "A string value definition. Commonly used for `shortcode_name`, `tag_name`, `content_key`, `include_name`, and similar definitions that identify snippet components by name.",
57366
+ "examples": [],
57367
+ "show_in_navigation": false
57368
+ },
57369
+ "developer_documentation": {
57370
+ "title": "String Value",
57371
+ "description": "A string value, commonly used for shortcode_name, tag_name, content_key, and similar definitions."
57372
+ },
57373
+ "url": "/configuration-file/types/snippet-definition-value/(string-value)/",
57374
+ "required": false,
57375
+ "key": "snippet-definition-value(string-value)",
57376
+ "full_key": "snippet-definition-value(string-value)",
57377
+ "parent": "type.snippet-definition-value",
57378
+ "appears_in": []
57379
+ },
57380
+ "type.snippet-definition-value.(number-value)": {
57381
+ "gid": "type.snippet-definition-value.(number-value)",
57382
+ "title": "Number Value",
57383
+ "description": "A numeric value definition. Use for counts, sizes, or other numeric values that can be referenced in snippet templates.",
57384
+ "type": "number",
57385
+ "documentation": {
57386
+ "gid": "type.snippet-definition-value.(number-value)",
57387
+ "url": "/configuration-file/types/snippet-definition-value/(number-value)/",
57388
+ "title": "Number Value",
57389
+ "description": "A numeric value definition. Use for counts, sizes, or other numeric values that can be referenced in snippet templates.",
57390
+ "examples": [],
57391
+ "show_in_navigation": false
57392
+ },
57393
+ "developer_documentation": {
57394
+ "title": "Number Value",
57395
+ "description": "A numeric value."
57396
+ },
57397
+ "url": "/configuration-file/types/snippet-definition-value/(number-value)/",
57398
+ "required": false,
57399
+ "key": "snippet-definition-value(number-value)",
57400
+ "full_key": "snippet-definition-value(number-value)",
57401
+ "parent": "type.snippet-definition-value",
57402
+ "appears_in": []
57403
+ },
57404
+ "type.snippet-definition-value.(boolean-value)": {
57405
+ "gid": "type.snippet-definition-value.(boolean-value)",
57406
+ "title": "Boolean Value",
57407
+ "description": "A boolean value definition. Use for flags and toggles that can be referenced in snippet templates.",
57408
+ "type": "boolean",
57409
+ "documentation": {
57410
+ "gid": "type.snippet-definition-value.(boolean-value)",
57411
+ "url": "/configuration-file/types/snippet-definition-value/(boolean-value)/",
57412
+ "title": "Boolean Value",
57413
+ "description": "A boolean value definition. Use for flags and toggles that can be referenced in snippet templates.",
57414
+ "examples": [],
57415
+ "show_in_navigation": false
57416
+ },
57417
+ "developer_documentation": {
57418
+ "title": "Boolean Value",
57419
+ "description": "A boolean value."
57420
+ },
57421
+ "url": "/configuration-file/types/snippet-definition-value/(boolean-value)/",
57422
+ "required": false,
57423
+ "key": "snippet-definition-value(boolean-value)",
57424
+ "full_key": "snippet-definition-value(boolean-value)",
57425
+ "parent": "type.snippet-definition-value",
57426
+ "appears_in": []
57427
+ },
57428
+ "type.snippet-definition-value.(string-array)": {
57429
+ "gid": "type.snippet-definition-value.(string-array)",
57430
+ "title": "String Array",
57431
+ "description": "An array of string values. Useful for defining lists of allowed values, delimiters, or other string collections that can be referenced in snippet templates.",
57432
+ "type": "array",
57433
+ "documentation": {
57434
+ "gid": "type.snippet-definition-value.(string-array)",
57435
+ "url": "/configuration-file/types/snippet-definition-value/(string-array)/",
57436
+ "title": "String Array",
57437
+ "description": "An array of string values. Useful for defining lists of allowed values, delimiters, or other string collections that can be referenced in snippet templates.",
57438
+ "examples": [],
57439
+ "show_in_navigation": false
57440
+ },
57441
+ "developer_documentation": {
57442
+ "title": "String Array",
57443
+ "description": "An array of strings."
57444
+ },
57445
+ "url": "/configuration-file/types/snippet-definition-value/(string-array)/",
57446
+ "required": false,
57447
+ "key": "snippet-definition-value(string-array)",
57448
+ "full_key": "snippet-definition-value(string-array)",
57449
+ "parent": "type.snippet-definition-value",
57450
+ "appears_in": [],
57451
+ "items": [
57452
+ {
57453
+ "gid": "type.snippet-definition-value.(string-array).[*]"
57042
57454
  }
57043
57455
  ]
57044
57456
  },
57457
+ "type.snippet-definition-value.(string-array).[*]": {
57458
+ "gid": "type.snippet-definition-value.(string-array).[*]",
57459
+ "title": "",
57460
+ "description": "A string item in the array.",
57461
+ "type": "string",
57462
+ "documentation": {
57463
+ "gid": "type.snippet-definition-value.(string-array).[*]",
57464
+ "url": "/configuration-file/types/snippet-definition-value/(string-array)/[*]/",
57465
+ "title": "",
57466
+ "description": "A string item in the array.",
57467
+ "examples": [],
57468
+ "show_in_navigation": false
57469
+ },
57470
+ "developer_documentation": {},
57471
+ "url": "/configuration-file/types/snippet-definition-value/(string-array)/[*]/",
57472
+ "required": false,
57473
+ "key": "snippet-definition-value(string-array)[*]",
57474
+ "full_key": "snippet-definition-value(string-array)[*]",
57475
+ "parent": "type.snippet-definition-value.(string-array)",
57476
+ "appears_in": []
57477
+ },
57045
57478
  "_snippets_definitions_from_glob": {
57046
57479
  "gid": "_snippets_definitions_from_glob",
57047
57480
  "title": "",