@liquid-labs/dmd

This is a fork of the dmd. Because jsdoc-to-markdown hard codes the 'dmd' package, you must use our fork of that project, @liquid-labs/jsdoc-to-markdown with this package.

This package adds the following features:

• grouping global identifiers,
• clever links and monospace links, and
• passes additional context when grouping identifiers.

This is all intended primarily for use with dmd-readme-api, which is a plugin that further modifies the DMD template with a number of enhancements including support for groped global identifiers, links to source code, links from documentation back to indexes, and just generally a more compact, style.

This package is being published because a number of my other projects rely on these changes. There are pull requests for all the changes and if/when they are incorporated into the original project, this one will be deprecated. On the other hand, if the changes are not adopted, then we will continue to maintain this fork.

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-24 Lloyd Brookes <75pound@gmail.com>.

Fork changes by Zane Rockenbaugh <zane@liquid-labs.com>

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