Generate markdown documents from JSON schema files ✨.
Choose one of the following:
-
Download and manually install the latest release
-
Install with Homebrew 🍺
brew install twelvelabs/tap/schemadoc
-
Install from source
go install github.com/twelvelabs/schemadoc@latest
# Renders `./my.schema.json` to `./out/SchemaTitle.md`.
schemadoc gen --in ./my.schema.json
# Renders all json schema files in `./schemas` to `./docs`.
schemadoc gen --in ./schemas --out ./docsgit clone git@github.com:twelvelabs/schemadoc.git
cd schemadoc
# Ensures all required dependencies are installed
# and bootstraps the project for local development.
make setup
make build
make test
make install
# Show help.
make