bootprint

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

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

• Command line interface - How to use Bootprint from the command line.
• JavaScript Usage - How to call Bootprint from JavaScript.
• JavaScript API-Reference - How to call Bootprint from JavaScript.
• Configuration Options - How to customize Bootprint for your own purposes.
• Developing modules - How to create your own modules for bootprint
• Release Notes

Available modules

• base contains a basic template as a base for other modules.
• json-schema creates readable docs from JSON-Schema-Definitions
• swagger creates readable docs from Swagger definitions.

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.