dmd-tf

3.0.3 • Public • Published

view on npm npm module downloads Build Status Dependency 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:

dmd(templateData)

produces this markdown output:

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

**Kind**: global variable

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

Readme

Keywords

Package Sidebar

Install

npm i dmd-tf

Weekly Downloads

2

Version

3.0.3

License

MIT

Last publish

Collaborators

  • develar