dmd

dmd

new version very close to release! see jsdoc-to-markdown

dmd

A transform stream taking javascript doclet data in (produced by jsdoc-parse or any source), outputing markdown documentation. Essentially, the library is collection of Handlebars templates and helpers, any of which can be overridden to taste. The main template is rendered using the data received at stdin.

$ cat examples/input/doclet.json
[
    {
        "name": "fatUse",
        "kind": "member",
        "description": "I am a global variable",
        "scope": "global"
    }
]
 
$ cat examples/input/doclet.json | dmd
# Global
 
## fatUse
I am a global variable

Install:

$ npm install dmd --save

Example:

var dmd = require("dmd");
 
process.stdin.pipe(dmd()).pipe(process.stdout);

Install the dmd tool globally:

$ npm install -g dmd

Example:

$ cat examples/doclet.json | dmd

API Reference

##dmd(options) ⏏ Transforms doclet data into markdown documentation

Params

  • options object - The render options
    • [template] string - A handlebars template to insert your documentation into.
    • [partial] string | Array.<string> - overrides
    • [helper] string | Array.<string> - overrides
    • [plugin] string | Array.<string> - packages containing overrides
    • [heading-depth] number - Root heading depth, defaults to 2.

Returns: stream - A transform stream - pipe doclet data in to receive rendered markdown.

documented by jsdoc-to-markdown