Working with JSON Schema

There are two ways to use JSON Schemas to build documentation pages.

• Directly use the JsonSchemaFields and JsonSchemaExample components.

• Specify the json_schema field in a pages front matter.

JSON Schema components

These components provide the ability to automatically generate fields and an example based on the JSON Schema file.

See JSON Schema Components.

Frontmatter

by setting the json_schema field in the front matter of a document both components will be automatically appended to the page.

See Document frontmatter.