JSON Schema for Humans vs Sandcastle Help File Builder
JSON Schema for Humans
json-schema-for-humans.readthedocs.ioSandcastle Help File Builder
github.comSide by side
| Figure | JSON Schema for Humans | Sandcastle Help File Builder |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | Yes | Yes |
| macOS | Yes | — |
| Linux | Yes | — |
| Self-hosted | Yes | — |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.6 (#3) | 7.4 (#24) |
| Purpose | The project generates static HTML or Markdown pages documenting JSON Schema. | SHFB provides tools for building help files for managed class libraries, including conceptual topics and API reference topics. |
Plans
Sandcastle Help File Builder
- Sandcastle Help File BuilderFree
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`.
Sandcastle Help File Builder
Sandcastle Help File Builder has no write-up on Specifiction yet; its figures are above.