bootprint / bootprint-monorepo Goto Github PK

View Code? Open in Web Editor NEW

41.0 41.0 7.0 4.26 MB

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

License: MIT License

JavaScript 74.76% HTML 22.61% CSS 2.63%

bootprint-monorepo's Introduction

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.

bootprint-monorepo's People

Stargazers

Watchers

Forkers

boopathiperumal kenuiuc gerritmerecs hroenick alingse-forks andgineer

bootprint-monorepo's Issues

[bootprint-openapi] Add npx command to readme?

You can skip the global install by doing:

npx -p bootprint-openapi -p bootprint bootprint openapi http://petstore.swagger.io/v2/swagger.json output-folder

That said, npx does not appear to cache any packages if they're specified explicitly at the command line, as above, so the above command does use extra data transfer if you need to run it more than once.

OpenAPI 3 field "requestBody" not interpreted

bootprint-openapi is really great and I hope you find enough contributors to maintain it.

I noticed one issue: In OpenAPI 3, the request body parameter is defined using the requestBody field. This seems not to be interpreted by bootprint-openapi though. Can this be (easily) added?

The documentation of the request body field is here:
https://swagger.io/docs/specification/describing-request-body/

bootprint-openapi has peerDependency to old bootprint

When installing bootprint-openapi via npm install -g bootprint bootprint-openapi I get the following error:

npm WARN [email protected] requires a peer of bootprint@^2.0.1 but none was installed.

Installing with npm install -g [email protected] bootprint-openapi in turn results in

npm WARN [email protected] requires a peer of bootprint@^4.0.1 but none was installed.
npm WARN [email protected] requires a peer of bootprint@^4.0.1 but none was installed.

I assume the peerDependency from [email protected] to [email protected] is a typo and should instead read [email protected] (since it has been updated just 10 days ago)?

Ability to change output file name & disable CSS building

Hi love the project!

I'm looking at using it to build Markdown documents based off JSON schemas.

I can create decent markdown documents easy enough using the handle bar templates and a few helpers but I can't find a nice way to do two things.

Change the output file name
Disable CSS creation.

Based on reading the code it looks like this isn't possible as both engines are created and configured in bootprint itself? Am I reading / not understanding correctly?

Cheers for any help in advance.