# dmd

> The default output template for jsdoc-to-markdown

Latest version **7.1.1** (published 2024-11-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install dmd
pnpm add dmd
yarn add dmd
bun add dmd
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.1.1 |
| Published | 2024-11-29 |
| First published | 2014-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12.17 |
| Dependencies | 7 |
| Unpacked size | 81.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 39 |
| Author | Lloyd Brookes |
| Maintainers | 75lb |
| Keywords | documentation, markdown |

## Links

- npm: https://www.npmjs.com/package/dmd
- Repository: https://github.com/jsdoc2md/dmd
- Homepage: https://github.com/jsdoc2md/dmd#readme
- Issues: https://github.com/jsdoc2md/dmd/issues
- npm.io page: https://npm.io/package/dmd

## Dependencies (7)

- [marked](https://npm.io/package/marked.md) ^4.3.0
- [file-set](https://npm.io/package/file-set.md) ^5.2.2
- [walk-back](https://npm.io/package/walk-back.md) ^5.1.1
- [array-back](https://npm.io/package/array-back.md) ^6.2.2
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.8
- [cache-point](https://npm.io/package/cache-point.md) ^3.0.0
- [common-sequence](https://npm.io/package/common-sequence.md) ^3.0.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 7.1.1 (latest) — 2024-11-29
- 7.0.0-3 (next) — 2024-08-30
- 7.1.0 — 2024-11-28
- 7.0.7 — 2024-09-25
- 7.0.6 — 2024-09-08
- 7.0.5 — 2024-09-01
- 7.0.4 — 2024-09-01
- 7.0.3 — 2024-08-31
- 7.0.2 — 2024-08-31
- 7.0.1 — 2024-08-31
- 7.0.0 — 2024-08-30
- 6.3.0-1 — 2024-08-30
- 7.0.0-2 — 2024-08-29
- 7.0.0-1 — 2024-08-29
- 7.0.0-0 — 2024-08-28
- … 112 more at https://npm.io/package/dmd/versions

## 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:

```
<a name="fatUse"></a>
## fatUse
I am a global variable

**Kind**: global variable
```

* * *

&copy; 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).

---
_Source: https://npm.io/package/dmd · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._