Asciidoctor Free plan 8.9 Visit JSON Schema for Humans
json-schema-for-humans.readthedocs.io
What it is
JSON Schema for Humans generates static HTML or Markdown documentation from valid JSON Schema files. Inputs can be JSON or YAML, supplied to its command-line interface as a file, directory, glob pattern, or comma-separated list; Python methods are also available. Multiple templates produce different outputs. The default JavaScript template provides expandable sections, tabs for conditional subschemas, and anchor links. The js_offline template bundles CSS and JavaScript for offline viewing. Markdown output can be published without an HTTP server and is rendered by GitHub when browsing code. A techdocs template is described as optimized for TechDocs and MkDocs Material. References can point within a schema, to local files, or to URLs, including circular references, and the project lists JSON Schema Draft-07 support. Safe mode escapes HTML tags in descriptions by default, while configuration can allow HTML. Property names and size, property dependencies, and media are listed as unsupported. The Apache-2.0 licensed package documents installation with `pip install json-schema-for-humans`.
Spec sheet
- Purpose
- The project generates static HTML or Markdown pages documenting JSON Schema.Read 9 Oct 2026 · github.com
- Integrations
- A `techdocs` template is described as optimized for TechDocs and MkDocs Material.Read 4 Oct 2026 · coveooss.github.io
- Support
- The project README invites contributions and directs users to its contributing guide.Read 4 Oct 2026 · github.com
- License
- The project is licensed under Apache License 2.0.Read 9 Oct 2026 · github.com
- Input formats
- The CLI accepts valid JSON Schema in JSON or YAML format, from a file, directory, glob pattern, or comma-separated list.Read 9 Oct 2026 · github.com
- Input requirements
- Inputs must be valid JSON Schema in JSON or YAML format; the CLI accepts a file, directory, glob pattern, or comma-separated list.Read 4 Oct 2026 · github.com
- Install
- The project documents installation with `pip install json-schema-for-humans`.Read 4 Oct 2026 · github.com
- Installation
- The README gives `pip install json-schema-for-humans` as the installation command.Read 9 Oct 2026 · github.com
- Intended audience
- The package metadata classifies the intended audience as developers and the topic as documentation.Read 9 Oct 2026 · github.com
- Interactive HTML
- The default JavaScript template provides expandable sections, tabs for conditional subschemas, and anchor links.Read 4 Oct 2026 · github.com
- Limitations
- The README lists property names and size, property dependencies, and media as unsupported at the time of writing.Read 9 Oct 2026 · github.com
- Limits
- The README lists property names and size, property dependencies, and media as currently unsupported.Read 4 Oct 2026 · github.com
- Markdown publishing
- The Markdown template can be published without hosting an HTTP server, and GitHub renders it when browsing code.Read 4 Oct 2026 · github.com
- Offline output
- The `js_offline` template bundles CSS and JavaScript resources for offline use.Read 4 Oct 2026 · github.com
- Offline use
- The `js_offline` template bundles CSS and JavaScript resources so generated documentation can be used offline.Read 9 Oct 2026 · github.com
- Output features
- It supports HTML and Markdown output, multiple templates, and anchor links to documentation sections.Read 9 Oct 2026 · github.com
- Output formats
- It supports HTML and Markdown output, with multiple built-in templates.Read 4 Oct 2026 · github.com
- Schema references
- It supports references within a schema, to local files, and to URLs, including circular references.Read 4 Oct 2026 · github.com
- Schema support
- The README lists support for JSON Schema Draft-07 and references, including circular references.Read 9 Oct 2026 · github.com
- Security handling
- The configuration documentation says HTML tags in descriptions are escaped by default, with options to replace them or allow HTML.Read 9 Oct 2026 · github.com
- Security setting
- For HTML descriptions, the documented default safe mode escapes HTML tags; the configuration also permits null to allow HTML.Read 4 Oct 2026 · coveooss.github.io
- Templates
- The README describes JavaScript-based, offline, flat HTML, and Markdown templates; it notes that flat and Markdown are works in progress.Read 9 Oct 2026 · github.com
- Ways to use
- Generation can be run from the CLI or called from Python code.Read 9 Oct 2026 · github.com
Plans and prices
Free / open source Free Apache-2.0 licensed Python package; generates static HTML or Markdown documentation Read 9 Oct 2026 · github.com
Strong points and limits
Strong points
- Generates HTML and Markdown
- Accepts JSON or YAML schemas
- Supports circular references
- Offline template bundles resources
- Command-line and Python interfaces
Limits
- Property names and size are listed as unsupported
- Property dependencies and media are listed as unsupported
- It does not generate API references
Who it suits
This tool suits developers who need generated schema documentation for repositories, offline use, GitHub, or TechDocs and MkDocs Material.
Verdict
JSON Schema for Humans provides documented command-line and Python paths to static schema pages, with templates for interactive, offline, Markdown, and TechDocs use. Its listed unsupported features should be checked against the schemas you need to publish.
Where Specifiction places it
- Documentation Generators#3 of 378.6
