JSON Schema for Humans

5.8easy start · #21 of 38
in Documentation Generators

Runs on Linux, Mac, self-hosted, Windows.

JSON Schema for Humans is ranked #21 of 38 in documentation generators on The Geeks Club. It runs on Linux, macOS, Self-hosted, Windows.

Compared on documentation generators

Scalar 0 of 4 in the starter kit Lesson 17.4 Sphinx 0 of 4 in the starter kit Lesson 27.4 Kotlin/JS 0 of 4 in the starter kit Lesson 37.3 Asciidoctor 0 of 4 in the starter kit Lesson 47.2 Doxygen 0 of 4 in the starter kit Lesson 57.1 Redocly 0 of 4 in the starter kit Lesson 67.1

Purpose: Generates static HTML or Markdown pages documenting JSON Schemas.
Install: The project documents installation with `pip install json-schema-for-humans`.
Ways to use: It offers a command-line interface and Python methods for generating documentation.
Schema references: It supports references within a schema, to local files, and to URLs, including circular references.
Interactive HTML: The default JavaScript template provides expandable sections, tabs for conditional subschemas, and anchor links.
Offline output: The `js_offline` template bundles CSS and JavaScript resources for offline use.
Markdown publishing: The Markdown template can be published without hosting an HTTP server, and GitHub renders it when browsing code.
Integrations: A `techdocs` template is described as optimized for TechDocs and MkDocs Material.
Limits: The README lists property names and size, property dependencies, and media as currently unsupported.
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.
Security setting: For HTML descriptions, the documented default safe mode escapes HTML tags; the configuration also permits null to allow HTML.
License: The repository says the software is licensed under the Apache License, Version 2.0.
Support: The project README invites contributions and directs users to its contributing guide.

Claim it for free: prove the domain, then correct facts, plans and screenshots. An editor reviews every change.