This PR provides a framework for building the MyST mdast schema with json schema. This follows the existing commonmark markdown mdast schema. It is similar to the json schema defined here, but is a bit more verbose / explicit and broken into multiple files to simplify extensibility with new MyST features.
Currently, the json schema supports all commonmark features; the commonmark spec examples are all included and validated.
The current structure is schema/ folder and subfolders, each of which has schema definitions, documentation md files, and example yaml files. There is also a test suite which validates all the example yaml files against the schema. We will add additional subfolders for new MyST features:
Overview video: https://www.loom.com/share/633e84c35a574a7cb09059323ab80efb
This PR provides a framework for building the MyST mdast schema with json schema. This follows the existing commonmark markdown mdast schema. It is similar to the json schema defined here, but is a bit more verbose / explicit and broken into multiple files to simplify extensibility with new MyST features.
Currently, the json schema supports all commonmark features; the commonmark spec examples are all included and validated.
The current structure is
schema/
folder and subfolders, each of which has schema definitions, documentation md files, and example yaml files. There is also a test suite which validates all the example yaml files against the schema. We will add additional subfolders for new MyST features: