Documenting and validating complex JSON Schemas can be hard. This tool makes it easier by providing a number of scripts that can turn JSON Schema files into readable Markdown documentation that is ready for consumption on GitHub or processed using Jekyll or other static site generators.
These tools have been introduced by Adobe to document Adobe's Experience Data Models (XDM), but can be used for other JSON Schema documents, too.
npmversion 3.10.8 or up
nodev6 or up
# clone this project$ git clone email@example.com:adobe/jsonschema2md.git# install dependencies$ cd jsonschema2md && npm install# show usage information$ node cli.js# run task$ node cli.js -d examples/schemas -o examples/docs# generated output for whole folder is written to ./examples/docs
jsonschema2mdCommand Line Tools
The JSON Schema Markdown tools also includes a convenient
jsonschema2md command line tool that can be installed using:
$ npm link
The command line arguments are identical between the
jsonschema2md binary and the
cli.js node script.
You can conveniently use the JSON Schema Markdown Tools from
npm. This makes it possible to set up a conversion toolchain for your JSON Schema project that is driven entirely by
npm. To do so, first define the dependency by adding this to your
"devDependencies" section of
Then add the following to the
"scripts" section of your
package.json and adapt accordingly:
If you run
npm install before running
npm run prepare,
npm will install the
jsonschema2md in a
node_modules/.bin path, even if you did not install the JSON Schema Markdown beforehand.
Ensure you have all the dependencies installed via
npm install, then run:
You can run
npm run cover to get a code coverage report, that is, a sense of how much of the project's code is "covered" by the test suite.
npm run lint
Please see Contributing.md for details. Pull requests are welcome.
Copyright 2017 Adobe Systems Incorporated. All rights reserved. This file is licensed to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0