bootprint-json-schema

bootprint-json-schema

Converts a json-schema into a static html page

This bootprint-module can be used to convert a json-schema to a human-readbable HTML.

Features

• Complete support for the keywords from JSON-schema draft-04 and draft-06
• Links to the specification for all keywords
• Full test coverage of JavaScript-code
• Lots of tests to cover Handlebars templates and partials

Installation

npm -g install bootprint
npm -g install bootprint-json-schema

Usage

After installing the package globally, you can run bootprint with the command

bootprint json-schema https://raw.githubusercontent.com/bootprint/bootprint-json-schema/v2.0.0-rc.2/examples/example.json target

example.json can be found in examples/example.json in this project. It is a copy of the fstab-example from the JSON-schema documentation, licensed under the AFL or BSD license.

Bootprint will then generate the following files:

examples/target/
├── index.html
├── main.css
└── main.css.map

Customizing

You can write your own module that customizes the partials and helpers in this module (see the bootprint documentation) for details.

The entrypoint JavaScript-file of such a module would look like.

module.exports = function (customize) {
  return customize
    .load(require('bootprint-json-schema'))
    .merge({
      // You customizations here
    })

// Add "package" metadata. This can be evaluated by documentation generators
module.exports.package = require('./package')

API

see docs/api.md

License

bootprint-json-schema is published under the MIT-license.

See LICENSE for details.

Release-Notes

For release notes, see CHANGELOG.md

Contributing guidelines

See CONTRIBUTING.md.