Skip to content
SPECIFICTION
Get listed

JSON Schema for Humans vs Sandcastle Help File Builder

JSON Schema for Humans

json-schema-for-humans.readthedocs.io

Sandcastle Help File Builder

github.com

Side by side

FigureJSON Schema for HumansSandcastle Help File Builder
Price fromFreeFree
Free planYesYes
Free trial——
Open source——
WindowsYesYes
macOSYes—
LinuxYes—
Self-hostedYes—
Plans published11
Spec score · Documentation Generators8.6 (#3)7.4 (#24)
PurposeThe 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

JSON Schema for Humans

  • Free / open sourceFree

JSON Schema for Humans pricing →

Sandcastle Help File Builder

  • Sandcastle Help File BuilderFree

Sandcastle Help File Builder pricing →

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`.

Visit json-schema-for-humans.readthedocs.io

Sandcastle Help File Builder

Sandcastle Help File Builder has no write-up on Specifiction yet; its figures are above.

Visit github.com