JSON Schemas

CloudCannon provides JSON Schemas for all configuration files, enabling autocomplete, validation, and inline documentation in your code editor.

All schemas are registered with SchemaStore. The JSON and YAML language servers in most code editors read the SchemaStore catalog and apply the matching schema based on the filename. Schemas are published as release assets of the @cloudcannon/configuration-types package on GitHub.

Available schemas#

All schemas are published under https://github.com/cloudcannon/configuration-types/releases/latest/download/.

Configuration File schemas

Split configuration files are matched by their extension. The extension names the kind of configuration the file holds, so a file referenced by collections_config_from_glob ends in .cloudcannon.collections.yml (for example, posts.cloudcannon.collections.yml⁠). Each extension below also matches with .yaml or .json in place of .yml.

For more information on the supporting files, please read our documentation on splitting your Configuration File.

Routing and Initial Site Settings schemas

Non-unified configuration SSG-specific schemas

For older Sites using the non-unified configuration format, the registered Configuration File schema also covers the SSG-specific legacy formats. Set the version key in your Configuration File to select which one applies:

• legacy-jekyll
• legacy-hugo
• legacy-eleventy
• legacy-reader (other SSGs using CloudCannon Reader)

version: legacy-jekyll

{
  "version": "legacy-jekyll"
}

When version is omitted or set to latest, the unified configuration schema applies.

We recommend migrating to Unified Configuration to benefit from the latest features.

IDE configuration#

Most code editors apply the schemas automatically through their JSON and YAML language servers. If you use a custom path for your Configuration File, SchemaStore cannot match it by filename. Each language server has its own setting for associating a schema with a file, so you can add the mapping there instead of in the file itself.

VS Code and Cursor

JSON files work automatically with no setup required. YAML files require the Red Hat YAML extension, which also applies schemas from SchemaStore automatically once installed.

To apply the schema to a custom Configuration File path, add a mapping to the json.schemas or yaml.schemas setting in your settings.json:

{
  "yaml.schemas": {
    "https://github.com/cloudcannon/configuration-types/releases/latest/download/cloudcannon-config.schema.json": "config/cms.yml"
  }
}

For more information, see the VS Code JSON Schema documentation.

JetBrains IDEs

WebStorm, IntelliJ IDEA, and other JetBrains IDEs have built-in JSON and YAML schema support that works automatically via SchemaStore integration.

To associate a schema manually, open JSON Schema Mappings under Languages & Frameworks in the IDE settings. See the JetBrains JSON Schema documentation for details.

Sublime Text

Install the LSP and LSP-json packages for JSON schema support. Schemas are automatically discovered via SchemaStore. For YAML files, also install LSP-yaml.

Neovim

Use nvim-lspconfig with jsonls for JSON files and yamlls for YAML files. Both language servers automatically discover schemas through SchemaStore.

Zed

Zed has built-in JSON schema support that works automatically via SchemaStore. See the Zed JSON documentation for more details.