JSON Schema for Humans vs YARD
JSON Schema for Humans
json-schema-for-humans.readthedocs.ioYARD
yardoc.orgSide by side
| Figure | JSON Schema for Humans | YARD |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | Yes |
| Self-hosted | Yes | — |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 8.6 (#3) | 7.1 (#29) |
| Installation | The README gives `pip install json-schema-for-humans` as the installation command. | The site instructs users to install YARD with the RubyGems command gem install yard. |
| Integrations | A `techdocs` template is described as optimized for TechDocs and MkDocs Material. | The site names plugins supporting RSpec, DataMapper, and Sinatra. |
| License | The project is licensed under Apache License 2.0. | The site states that YARD uses the MIT License. |
| Purpose | The project generates static HTML or Markdown pages documenting JSON Schema. | YARD generates consistent, usable documentation for the Ruby programming language and can export it to different formats. |
| Support | The project README invites contributions and directs users to its contributing guide. | The site lists an IRC channel, a mailing list, and GitHub as ways to get in touch. |
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`.