Sign inSign up

gisaia/jsonschema2md

By gisaia

Updated almost 2 years ago

Generate markdown documentation for a given JSON Schema. Relies on adobe/jsonschema2md

Image
0

1.4K

gisaia/jsonschema2md repository overview

Usage

  • Place your terminal in the desire folder (where *.schema.json files can be accessed)
  • Mount the project folder as a volume when you run the docker
  • Define parameter -d to specify the source folder containing schema.json file => /!\ required /!\
  • Use the option -o to specify the output folder
  • Use the option -x with value - to suppress output of json files
docker run --rm -v `pwd`:/schema gisaia/jsonschema2md:0.1.2 -d /schema/json -o /schema/out -x -

Help

By running the container without parameters you can see all options availables

docker run --rm -v `pwd`:/schema gisaia/jsonschema2md:0.1.2

Tag summary

Content type

Image

Digest

sha256:b7c247861

Size

49.5 MB

Last updated

almost 2 years ago

docker pull gisaia/jsonschema2md