Page Front Matter (page)

JSON Schema

{
  "$id": "https://platen.io/modules/schematize/config/content/page/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Optional settings for the schematize module on a content page.\n\nhttps://platen.io/modules/schematize/config/content/page/",
  "properties": {
    "outputs": {
      "default": [
        "html",
        "schematize"
      ],
      "description": "Define output formats for a page\n\nhttps://platen.io/modules/schematize/config/content/page/#outputs",
      "items": {
        "type": "string"
      },
      "title": "Output Formats",
      "type": "array"
    }
  },
  "title": "Page Front Matter",
  "type": "object"
}

Schematize Path (schematize)

Specifies the dot-path to the schema data in the site’s data map. Schematize is designed to handle schema definitions in a site’s data/schemas folder, and uses dot-pathing to find schemas in that map. For example, to access the data in data/schemas/foo/bar/baz, the dot-path for this value would be foo.bar.baz.

If this value is defined on a page and no dot path is specified for the schematize shortcode, this value is used to find, parse, and render the documentation.

Output Formats (outputs)

Uses Hugo’s output formats to ensure that the schematize module can convert the data specified in schematize and publish it as a cleaned JSON schema. If this value isn’t set to include schematize in the array of outputs, the JSON Schema won’t be published.

If this value doesn’t include html, only the JSON Schema will be published, not the accompanying HTML page with the documentation added through the schematize shortcode.

<h3 id="outputs.default">Default Value</h3>

[
  "html",
  "schematize"
]