Code Monkey home page Code Monkey logo

bootprint-base's Introduction

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-base's People

Contributors

greenkeeper[bot] avatar nknapp avatar

Stargazers

avatar avatar avatar

Watchers

avatar

Forkers

lohanbodevan

bootprint-base's Issues

New line issue in the "json" helper

Issue description

The 'json' helper function adds an extra new line at the end of the parsed object. This happens because the parsed result is inside the <pre> HTML tag.

Example

{
    "title": "This is an example object",
    "message": "The 'json' helper will add an additional new line after the object"
}

Proposed solution

Remove the new line from the parsed 'json' objects:
in the file /handlebars/helpers.js modify the line 171 in order to make it like:

return new Handlebars.SafeString($.html().replace(/\n/g, ''))

If you want I can submit a Pull Request.

An in-range update of mocha is breaking the build 🚨

Version 3.3.0 of mocha just got published.

Branch Build failing 🚨
Dependency mocha
Current Version 3.2.0
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

As mocha is “only” a devDependency of this project it might not break production or downstream projects, but “only” your build or test tools – preventing new deploys or publishes.

I recommend you give this issue a high priority. I’m sure you can resolve this 💪

Status Details - ❌ **continuous-integration/travis-ci/push** The Travis CI build could not complete due to an error [Details](https://travis-ci.org/bootprint/bootprint-base/builds/225166199),- ✅ **coverage/coveralls** First build on greenkeeper/mocha-3.3.0 at 14.754% [Details](https://coveralls.io/builds/11210310)
Release Notes coverave

Thanks to all our contributors, maintainers, sponsors, and users! ❤️

As highlights:

  • We've got coverage now!
  • Testing is looking less flaky \o/.
  • No more nitpicking about "mocha.js" build on PRs.

🎉 Enhancements

  • #2659: Adds support for loading reporter from an absolute or relative path (@sul4bh)
  • #2769: Support --inspect-brk on command-line (@igwejk)

🐛 Fixes

  • #2662: Replace unicode chars w/ hex codes in HTML reporter (@rotemdan)

🔍 Coverage

🔩 Other

Commits

The new version differs by 89 commits0.

  • fb1687e :ship: Release v3.3.0
  • 1943e02 Add Changelog for v3.3.0
  • 861e968 Refactor literal play-icon hex code to a var
  • 1d3c5bc Fix typo in karma.conf.js
  • 9bd9389 Fix spec paths in test HTML files
  • 0a93024 Adds tests for loading reporters w/ relative/absolute paths (#2773)
  • 73929ad Comment special treatment of '+' in URL query parsing
  • e2c9514 Merge pull request #2769 from igwejk/support_inspect_break_in_opts
  • 038c636 Support --inspect-brk on command-line
  • b4ebabd Merge pull request #2727 from lamby/reproducible-build
  • 882347b Please make the build reproducible.
  • a2fc76c Merge pull request #2703 from seppevs/cover_utils_some_fn_with_tests
  • ed61cd0 cover .some() function in utils.js with tests
  • f42cbf4 Merge pull request #2701 from craigtaub/landingSpec
  • 6065242 use stubbed symbol

There are 89 commits in total.

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

Your Greenkeeper Bot 🌴

An in-range update of handlebars is breaking the build 🚨

Version 4.0.7 of handlebars just got published.

Branch Build failing 🚨
Dependency handlebars
Current Version 4.0.6
Type dependency

This version is covered by your current version range and after updating it in your project the build failed.

handlebars is a direct dependency of this project this is very likely breaking your project right now. If other packages depend on you it’s very likely also breaking them.
I recommend you give this issue a very high priority. I’m sure you can resolve this 💪

Status Details - ❌ **coverage/coveralls** Coverage pending from Coveralls.io [Details](https://coveralls.io/builds/11305065),- ❌ **continuous-integration/travis-ci/push** The Travis CI build could not complete due to an error [Details](https://travis-ci.org/bootprint/bootprint-base/builds/227225032?utm_source=github_status&utm_medium=notification)
Commits

The new version differs by 10 commits0.

  • 606fa55 v4.0.7
  • 8e09f0e Update release-notes for 4.0.7
  • c8f4b57 Fix context-stack when calling block-helpers on null values
  • b617375 Parser: Change suffix to use ES6 default module export
  • 63a8e0c Add more tests for partial-blocks and inline partials
  • 5a164d0 Fix for #1252: Using @partial-block twice in a template not possible
  • 01b0f65 Avoid duplicate "sourceMappingURL=" lines.
  • 406f2ee require('sys') is deprecated, using 'util' instead
  • a023cb4 Make "column"-property of Errors enumerable
  • c7dc353 Testcase to verify that compile-errors have a column-property

false

See the full diff

Not sure how things should work exactly?

There is a collection of frequently asked questions and of course you may always ask my humans.

Your Greenkeeper Bot 🌴

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.