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.

Last updated 8 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

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

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)

Downloads

Total 101

Today 0

This Week 0

This Month 0

Last Day 0

Last Week 0

Last Month 0

Dependencies (18)

array-back ^1.0.3
common-sequence ^1.0.2
core-js ^2.4.1
file-set ^1.0.1
handlebars ^3.0.3
handlebars-array ~0.2.0
handlebars-comparison ^2.0.0
handlebars-json ^1.0.0
handlebars-regexp ^1.0.0
handlebars-string ^2.0.1
marked ~0.3.6
object-get ^2.1.0
reduce-flatten ^1.0.1
reduce-unique ^1.0.0
reduce-without ^1.0.1
string-tools ^1.0.0
test-value ^2.0.0
walk-back ^2.0.1

Dev Dependencies (2)

dmd-plugin-example ~0.1.0
tape ^4.6.0

Dependents (1)

jsdoc-to-markdown

© 2010 - cnpmjs.org x YWFE | Home | YWFE