Skip to content
SPECIFICTION
Get listed

JSON Schema for Humans vs TypeDoc

JSON Schema for Humans

json-schema-for-humans.readthedocs.io

TypeDoc

typedoc.org

Side by side

FigureJSON Schema for HumansTypeDoc
Price fromFreeFree
Free planYesYes
Free trial——
Open source——
WindowsYes—
macOSYes—
LinuxYesYes
API—Yes
Self-hostedYesYes
Plans published11
Spec score · Documentation Generators8.6 (#3)8.0 (#10)
InstallationThe README gives `pip install json-schema-for-humans` as the installation command.TypeDoc runs on Node.js and is available as an npm package.
IntegrationsA `techdocs` template is described as optimized for TechDocs and MkDocs Material.The GitHub Pages option generates a .nojekyll file, and source links can use GitHub or Bitbucket remotes.
LicenseThe project is licensed under Apache License 2.0.The TypeDoc repository identifies its license as Apache-2.0.
Output formatsIt supports HTML and Markdown output, with multiple built-in templates.The default output is HTML, and TypeDoc can also write a JSON model describing the project.
PurposeThe project generates static HTML or Markdown pages documenting JSON Schema.TypeDoc converts comments in TypeScript source code into HTML documentation or a JSON model.
SupportThe project README invites contributions and directs users to its contributing guide.The project README invites users to open an issue or pull request on GitHub and points contributors to its contribution guide.

Plans

JSON Schema for Humans

  • Free / open sourceFree

JSON Schema for Humans pricing →

TypeDoc

  • Free and open sourceFree

TypeDoc 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

TypeDoc

TypeDoc is a free TypeScript documentation generator that turns source comments into HTML pages or a JSON model. It builds from project exports and follows re-exports, allowing members declared elsewhere to appear in documentation. TSDoc and JSDoc tags are extracted, Markdown is accepted in comments, and fenced code blocks receive Shiki syntax highlighting. HTML and JSON are built in; Markdown output needs a plugin such as typedoc-plugin-markdown. A default theme is included, while plugins can add themes, alter conversion and symbol organization, or change display. Custom CSS and JavaScript can further adjust generated pages. Configuration can come from an options file, package.json, or tsconfig.json. TypeDoc runs on Node.js, uses the TypeScript compiler, and supports the current Node.js LTS or newer. For npm monorepos, the packages entry-point strategy can combine package documentation into one site. The project is Apache-2.0 licensed. Documentation warns that global installation can separate plugins and themes from the intended TypeDoc installation.

Visit typedoc.org