Code Monkey home page Code Monkey logo

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.

Bootprint's Projects

bootprint icon bootprint

Converts json into a static html page using Handlebars and Bootstrap, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/bootprint

bootprint-json-schema icon bootprint-json-schema

Bootprint template to convert JSON-schema into readble HTML, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/bootprint-json-schema

bootprint-monorepo icon bootprint-monorepo

One repo for all bootprint and customize packages that are relevant to bootprint

bootprint-openapi icon bootprint-openapi

Bootprint-module to render OpenAPI specifications, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/bootprint-openapi

bootprint-unit-testing icon bootprint-unit-testing

Unit-testing-tools for bootprint-projects, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/bootprint-unit-testing

customize icon customize

This repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/customize

customize-engine-handlebars icon customize-engine-handlebars

A handlebars-adapter for Customize, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/customize-engine-handlebars

customize-engine-less icon customize-engine-less

A less-engine for customize, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/customize-engine-less

customize-write-files icon customize-write-files

Post-processor that stores the result of a customize-run in a local directory, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/bootprint-write-files

nock icon nock

HTTP mocking and expectations library

thought-plugin-bootprint icon thought-plugin-bootprint

A thought-plugin for Bootprint modules, this repository has moved to https://github.com/bootprint/bootprint-monorepo/tree/master/packages/thought-plugin-bootprint

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.