Run go run . generate-json-schema
, this will create docs/schema.json
- (Run only once) Install
json-schema-for-humans
, requirespip
:pip install json-schema-for-humans
- Run
generate-schema-doc --config template_name=md docs/schema.json docs/config-file.md
, this will create docs/config-file.md
- (Run only once) Install
json-schema-for-humans
, requirespip
:pip install json-schema-for-humans
. NOTE: this is the same tool as in previous step, so if you've already isntalled it, no need to do it again - Run
generate-schema-doc docs/schema.json docs/index.html
, this will createdocs/index.html
,docs/schema_doc.html
,docs/schema_doc.html
. Visualization using GitHub Pages
- (Run only once) Install dependency (requires python)
pip install jsonschema-default
- Update the defaults of the project (config/default.go) and generate a example JSON with the defaults (docs/example.json):
cd utils
python3 default_generator.py