Skip to content

JSON Spec Writer

SeanMcOwen edited this page May 16, 2024 · 2 revisions

Summary

MSML utilizes a JSON spec writer to take the JSON spec defined here and write out an entire documentation folder with definitions of all the components and how they need to be entered into the JSON structure.

Using the writer

To write the JSON spec documentation, the following must be done:

  1. Install jsonschema2md
  2. Run the following in a terminal which is in the root directory:

jsonschema2md -d "src/" -o "docs/JSON-Specification"

Clone this wiki locally