{"repo":"adobe/jsonschema2md","free":true,"listed":false,"github":"https://github.com/adobe/jsonschema2md","clone":"git clone https://github.com/adobe/jsonschema2md.git","description":"Convert Complex JSON Schemas into Markdown Documentation","language":"JavaScript","stars":722,"topics":["json-schema","markdown"],"license":"Apache-2.0","category":"productivity","readme_excerpt":"JSON Schema Markdown Tools 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. JSON Schema Support jsonschema2md is developed against JSON Schema 2019-09 , but not the full vocabulary is supported. Please check the detailed list of JSON Schema keywords supported by jsonschema2md . This list is updated by our tests. Requirements - npm version 3.10.8 or up - node v18 or v20 or up Example Output Using the schemas in examples/schemas (note the .schema.json extension), the output in examples/docs has been generated. Installing and running By default, jsonschema2md looks for schema files ending in .schema.json . You can specify another extension by using the --schema-extension or -e command line argument. Internationalization The generated documentation can be internationalized. Select the language you want to use for the output using the -l parameter. Supported languages are: - English - German If you want to provide a translation of your own, please use GitLocalize Display custom attributes in the property description jsonschema2md displays only the attributes of an property which are defined by the JSON ","default_branch":null,"files":null,"tree":[],"storefront":"/r/adobe","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/adobe/jsonschema2md/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}