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:

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

run through this command:

`js
const dmd = require('dmd')
dmd(templateData)
`

produces this markdown output:

`



fatUse

Kind: global variable
``

*

© 2014-24 Lloyd Brookes \<75pound@gmail.com\>.

Tested by test-runner. Documented by jsdoc-to-markdown.