JSON Schema for Humans vs TechWriter for Databases
JSON Schema for Humans
json-schema-for-humans.readthedocs.ioTechWriter for Databases
techwriter.meSide by side
| Figure | JSON Schema for Humans | TechWriter for Databases |
|---|---|---|
| Price from | Free | $49/mo |
| Free plan | Yes | — |
| Free trial | — | Yes |
| Open source | — | — |
| Windows | Yes | Yes |
| macOS | Yes | — |
| Linux | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 2 |
| Spec score · Documentation Generators | 8.6 (#3) | 7.6 (#20) |
| Output formats | It supports HTML and Markdown output, with multiple built-in templates. | It can generate PDF, Compiled Help (CHM), Word/RTF, HTML, XPS and XML documentation. |
| Purpose | The project generates static HTML or Markdown pages documenting JSON Schema. | TechWriter for Databases uses database information to automatically produce reference documentation. |
| Support | The project README invites contributions and directs users to its contributing guide. | The maker lists support requests, product updates and online documentation, with the first 12 months of support included with a license purchase. |
Plans
TechWriter for Databases
- TechWriter for Databases$179, paid once
- TechWriter Complete subscription license$49 a month
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`.
TechWriter for Databases
TechWriter for Databases has no write-up on Specifiction yet; its figures are above.