README.md

dbootstrap

dbootstrap (document with bootstrap) is an output template for jsdoc-to-markdown. It contains handlebars partials and helpers intended to transform jsdoc-parse output into html API documentation with bootstrap components.

For more documentation see the jsdoc2md wiki.

Synopsis

To give the most basic example, this input data:

const templateData = [
  {
    id: "fatUse",
    name: "fatUse",
    kind: "member",
    description: "I am a global variable",
    scope: "global"
  }
]

run through this command:

const dbootstrap = require('dbootstrap')
dbootstrap(templateData)

produces this html output:

<a name="fatUse"></a>
## fatUse
I am a global variable

**Kind**: global variable