node package manager
It’s your turn. Help us improve JavaScript. Take the 2017 JavaScript Ecosystem Survey »

bootprint

bootprint

NPM version Travis Build Status Coverage Status Greenkeeper badge

Converts json and yaml into a static html page using Handlebars and Bootstrap

Bootprint logo

Bootprint is a tool for converting JSON-files into static HTML-pages using {less}, Bootstrap and Handlebars.

It is designed with flexibility in mind:

  • You can easily modify the styling by providing your own {less}-files.
  • You can easily replace the Handlebars template and any register partial
  • You can include custom handlebars-helpers or override existing ones.
  • You can create packages with default-configurations, publish them on npm and use them as base for further customizations.

Installation

npm install -g bootprint

Usage

After installing bootprint perform the following steps

# Install template module 
npm install -g bootprint-openapi
# Run bootprint with the template 
bootprint openapi http://petstore.swagger.io/v2/swagger.json target

The directory "target" should now contain a file index.html and main.css which contain a readable form of the Swagger-Petstore-Example.

Further documentation Documentation

Available modules

License

bootprint is published under the MIT-license.

See LICENSE for details.

Release-Notes

For release notes, see CHANGELOG.md

Contributing guidelines

See CONTRIBUTING.md.