jsonschema2md
Convert JSON Schemas to simple, human-readable Markdown documentation.
For example:
{
"$id": "https://example.com/person.schema.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Person",
"description": "JSON Schema for a person object.",
"type": "object",
"properties": {
"firstName": {
"type": "string",
"description": "The person's first name."
},
"lastName": {
"type": "string",
"description": "The person's last name."
}
}
}
will be converted to:
Person
JSON Schema for a person object.
Properties
firstName(string): The person's first name.lastName(string): The person's last name.
There's also the possibility to translate it to another language. For example, the same schema in French would result in:
Person
JSON Schema for a person object.
Propriétés
firstName(chaîne de caractères): The person's first name.lastName(chaîne de caractères): The person's last name.
See the examples directory for more elaborate examples.
Installation
Install with pip
pip install jsonschema2md
Usage
From the CLI
jsonschema2md [OPTIONS] <input.json> <output.md>
From Python
import json
import jsonschema2md
parser = jsonschema2md.Parser(
examples_as_yaml=False,
show_examples="all",
)
with open("./examples/food.json", "r") as json_file:
md_lines = parser.parse_schema(json.load(json_file))
print(''.join(md_lines))
Options
examples_as_yaml: Parse examples in YAML-format instead of JSON. (bool, default:False)show_examples: Parse examples for only the main object, only properties, or all. (str, defaultall, options:object,properties,all)show_deprecated: Show deprecated properties. (bool, default:True)collapse_children: Collapse object children into a<details>element (bool, default:False)header_level: Base header level for the generated markdown. (int, default:0)ignore_patterns: List of regex patterns to ignore when parsing the schema. (list of str, default:None)
pre-commit hook
You can use the pre-commit hook with:
repos:
- repo: https://github.com/sbrunner/jsonschema2md
rev: <version> # Use the ref you want to point at
hooks:
- id: jsonschema2md
files: schema.json
args:
- --pre-commit
- schema.json
- schema.md
Contributing
Bugs, questions or suggestions? Feel free to post an issue in the issue tracker or to make a pull request! See Contributing.md for more info.
Install the pre-commit hooks:
pip install pre-commit
pre-commit install --allow-missing-config
Showcase
Related projects:
Metadata
Release files for jsonschema2md2 1.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| jsonschema2md2-1.7.0.tar.gz | 20.0 kB | Without provenance | Details for jsonschema2md2-1.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| jsonschema2md2-1.7.0-cp313-cp313-manylinux_2_39_x86_64.whl | CPython 3.13 | CPython 3.13 | Linux glibc 2.39+ x86-64 | Details for jsonschema2md2-1.7.0-cp313-cp313-manylinux_2_39_x86_64.whl |
Total release size: 43.0 kB
Release files / jsonschema2md2-1.7.0.tar.gz
| Download URL | jsonschema2md2-1.7.0.tar.gz |
|---|---|
| Size | 20.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
487dd9a93f85640a49153e5931b50fc73c469d7403125b9769828c072ff7f2a8
|
|
BLAKE2b-256 checksum How to use checksums |
96535f25ec18f39c57bb263f0b2fe10d05797c53fcf001f98ad27cbc3f26b48a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Release files / jsonschema2md2-1.7.0-cp313-cp313-manylinux_2_39_x86_64.whl
| Download URL | jsonschema2md2-1.7.0-cp313-cp313-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 23.0 kB |
| Tags | CPython 3.13 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
a89dc230b30a399d5f8e91a04429d2cae6a100e8d540571a274e155df36ce489
|
|
BLAKE2b-256 checksum How to use checksums |
3c761f2f9ce64106d8f46f07722e47bb84c36155d5cc8281de1c73500b46dc60
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Security for jsonschema2md2 1.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.