JSON Schema for Humans vs mdBook
JSON Schema for Humans
json-schema-for-humans.readthedocs.iomdBook
rust-lang.github.ioSide by side
| Figure | JSON Schema for Humans | mdBook |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | Yes | Yes |
| macOS | Yes | Yes |
| Linux | Yes | Yes |
| Self-hosted | Yes | — |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.6 (#3) | 7.8 (#12) |
| Integrations | A `techdocs` template is described as optimized for TechDocs and MkDocs Material. | The documentation describes using GitHub Actions or GitLab CI/CD to test and deploy books automatically. |
| Purpose | The project generates static HTML or Markdown pages documenting JSON Schema. | mdBook is a command-line tool for creating books from Markdown, including product or API documentation, tutorials, and course materials. |
| Support | The project README invites contributions and directs users to its contributing guide. | The project directs users to its GitHub issue tracker for issues and feature requests and relies on community contributions to fix bugs and add features. |
Plans
In their own words
JSON Schema for Humans
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`.
mdBook
mdBook is a free command-line tool for creating books from Markdown, including product and API documentation, tutorials, and course materials. It builds static output files in a book directory that can be transferred to a web service. Integrated search and syntax highlighting for code blocks help readers navigate and read examples, while theme files allow formatting changes. Preprocessors can add custom syntax or modify content; backends can render output to multiple formats. The `mdbook test` command tests Rust code samples in a book. Project documentation describes using GitHub Actions or GitLab CI/CD to test and deploy books automatically. Developers can also import mdBook libraries or use its plugin mechanism to build custom tooling and output backends. It runs on Linux, macOS, and Windows, and Markdown is its source input. Building from source requires Rust and Cargo, with Rust 1.88 as the stated minimum. The project directs issues and feature requests to its GitHub issue tracker and relies on community contributions for bug fixes and added features. The free, open-source plan is licensed under MPL-2.0.