package
The default output template for jsdoc-to-markdown
npm install dmdGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
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.
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-24 Lloyd Brookes <75pound@gmail.com>.
Tested by test-runner. Documented by jsdoc-to-markdown.
Estimated unpacked size across 19 packages.
5.5 MB
Includes dependencies.
7 direct · 1 outdated
^4.3.0
18.2.0
^5.2.2
5.3.0
^5.1.1
5.1.2
^6.2.2
6.2.3
^4.7.8
4.7.10
^3.0.0
3.0.1
^3.0.0
3.0.0