{"repo":"elisiariocouto/jsonschema-markdown","free":true,"listed":false,"github":"https://github.com/elisiariocouto/jsonschema-markdown","clone":"git clone https://github.com/elisiariocouto/jsonschema-markdown.git","description":"📖 Generate markdown documentation based on a JSON Schema document","language":"Python","stars":35,"topics":["documentation","documentation-generator","jsonschema","markdown","jsonschema-markdown"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"jsonschema-markdown Generate markdown documentation from JSON Schema files. The main goal is to generate documentation that is easy to read and understand. Can be used as a command line tool or as a library. Easy to use in CI/CD pipelines, as a Docker image is available. Note: This project follows CalVer (YYYY.MM.MICRO) versioning and maintains backward compatibility whenever possible. New features and enhancements are always encouraged! Installation Usage To use jsonschema-markdown as a CLI, just pass the filename as an argument and redirect the output to a file. Usage with Docker The jsonschema-markdown command is also available as a Docker image. To use it, you can mount the schema file as a volume. ⚠️ Warning : Do not pass the -t flag. The Docker image is available at: - elisiariocouto/jsonschema-markdown - ghcr.io/elisiariocouto/jsonschema-markdown Usage as a library To use it as a library, load your JSON schema file as Python dict and pass it to generate. The function will return a string with the markdown. Features The goal is to support the latest JSON Schema specification, 2020-12 . However, this project does not currently support all features, but it should support: - Required fields - String patterns - Enumerations - Default values - Descriptions and titles - Nested objects using $defs or definitions - Nested objects with dot notation (e.g., parent.child[].property ) - Basic oneOf , anyOf , allOf functionality - Conditional schemas with if / then / else - Arrays - ","default_branch":null,"files":null,"tree":[],"storefront":"/r/elisiariocouto","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/elisiariocouto/jsonschema-markdown/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."}