Jazzy vs JSON Schema for Humans
Jazzy
github.comJSON Schema for Humans
json-schema-for-humans.readthedocs.ioSide by side
| Figure | Jazzy | JSON Schema for Humans |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | — | Yes |
| macOS | Yes | Yes |
| Linux | Yes | Yes |
| Self-hosted | — | Yes |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 7.7 (#14) | 8.6 (#3) |
| Limitations | In Swift mode, Jazzy documents public and open declarations by default; symbol-graph mode exposes comments only for public declarations. | The README lists property names and size, property dependencies, and media as unsupported at the time of writing. |
| Purpose | Jazzy is a command-line utility that generates documentation for Swift and Objective-C. | The project generates static HTML or Markdown pages documenting JSON Schema. |
| Support | The README links to installation troubleshooting guidance and asks users to report code-of-conduct concerns to [email protected]. | The project README invites contributions and directs users to its contributing guide. |
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`.