https://github.com/jsdoc2md/dmd

The default output template for jsdoc2md
https://github.com/jsdoc2md/dmd

Last synced: about 1 year ago
JSON representation

The default output template for jsdoc2md

• Host: GitHub
• URL: https://github.com/jsdoc2md/dmd
• Owner: jsdoc2md
• License: mit
• Created: 2014-07-14T17:52:32.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2024-11-29T15:24:56.000Z (over 1 year ago)
• Last Synced: 2025-03-31T22:23:48.578Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 1.36 MB
• Stars: 39
• Watchers: 1
• Forks: 49
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![view on npm](https://badgen.net/npm/v/dmd)](https://www.npmjs.org/package/dmd)

[![npm module downloads](https://badgen.net/npm/dt/dmd)](https://www.npmjs.org/package/dmd)

[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/dmd)](https://github.com/jsdoc2md/dmd/network/dependents?dependent_type=REPOSITORY)

[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/dmd)](https://github.com/jsdoc2md/dmd/network/dependents?dependent_type=PACKAGE)

[![Node.js CI](https://github.com/jsdoc2md/dmd/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/dmd/actions/workflows/node.js.yml)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)

# dmd

dmd (document with markdown) is the default output template for [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown). It contains [handlebars](http://handlebarsjs.com) partials and helpers intended to transform [jsdoc-parse](https://github.com/jsdoc2md/jsdoc-parse) output into markdown API documentation.

For more documentation see the [jsdoc2md wiki](https://github.com/jsdoc2md/jsdoc-to-markdown/wiki).

## Synopsis

To give the most basic example, this input data:

```js

const templateData = [

  {

    id: "fatUse",

    name: "fatUse",

    kind: "member",

    description: "I am a global variable",

    scope: "global"

  }

]

```

run through this command:

```js

const dmd = require('dmd')

dmd(templateData)

```

produces this markdown output:

```



## fatUse

I am a global variable

**Kind**: global variable

```

* * *

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

Tested by [test-runner](https://github.com/test-runner-js/test-runner). Documented by [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).