dmd

dmd (document with markdown) is a collection of handlebars templates for generating markdown documentation from jsdoc-parse input data. It is the default template set used by jsdoc-to-markdown.

this release is now out of date, please install the latest version

Last updated 10 years ago by 75lb .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ npm install dmd

SYNC missed versions from official npm registry.

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

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

Current Tags

7.0.7 ... latest (2 months ago)
7.0.0-3 ... next (3 months ago)

125 Versions

Maintainers (1)

75lb

Downloads

Total 101

Today 0

This Week 0

This Month 0

Last Day 0

Last Week 0

Last Month 0

Dependencies (6)

array-tools ^1.3.0
boil ~0.3.0
command-line-args ~0.5.1
console-dope ~0.3.6
ddata ~0.1.0
object-tools ^1.1.1

Dev Dependencies (2)

tap-spec ^2.2.1
tape ^3

Dependents (1)

jsdoc-to-markdown