Skip to content
The default output template for jsdoc2md
Branch: master
Clone or download
Latest commit a4b31ec Oct 19, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
helpers
lib
partials Escape underscores in identifier signature (#59) Oct 18, 2018
test
.gitignore
.travis.yml
LICENSE upgrade deps Dec 20, 2017
README.md
package-lock.json
package.json

README.md

view on npm npm module downloads Build Status js-standard-style Join the chat at https://gitter.im/jsdoc2md/jsdoc2md

dmd

dmd (document with markdown) is the default output template for jsdoc-to-markdown. It contains handlebars partials and helpers intended to transform jsdoc-parse output into markdown API documentation.

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 dmd = require('dmd')
dmd(templateData)

produces this markdown output:

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

**Kind**: global variable

© 2014-2018 Lloyd Brookes <75pound@gmail.com>. Documented by jsdoc-to-markdown.

You can’t perform that action at this time.