# jsdoc-to-markdown

> Generates markdown API documentation from jsdoc annotated source code

Latest version **9.1.3** (published 2025-10-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install jsdoc-to-markdown
pnpm add jsdoc-to-markdown
yarn add jsdoc-to-markdown
bun add jsdoc-to-markdown
```

Provides the command `jsdoc2md`.

## Health

**Score 58/100 (C)** — status: stable.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 9.1.3 |
| Published | 2025-10-03 |
| First published | 2014-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/jsdoc-to-markdown) |
| Module format | ESM |
| Node | >=12.17 |
| Dependencies | 8 |
| Unpacked size | 30.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1759 |
| Author | Lloyd Brookes |
| Maintainers | 75lb |
| Keywords | jsdoc, markdown, api, generator, javascript, js, documentation |

## Links

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

## Dependencies (8)

- [dmd](https://npm.io/package/dmd.md) ^7.1.1
- [jsdoc-api](https://npm.io/package/jsdoc-api.md) ^9.3.5
- [walk-back](https://npm.io/package/walk-back.md) ^5.1.1
- [array-back](https://npm.io/package/array-back.md) ^6.2.2
- [jsdoc-parse](https://npm.io/package/jsdoc-parse.md) ^6.2.5
- [config-master](https://npm.io/package/config-master.md) ^3.1.0
- [command-line-args](https://npm.io/package/command-line-args.md) ^6.0.1
- [command-line-usage](https://npm.io/package/command-line-usage.md) ^7.0.3

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 9.1.3 (latest) — 2025-10-03
- 9.1.2 — 2025-07-17
- 9.1.1 — 2024-11-29
- 9.1.0 — 2024-11-28
- 9.0.5 — 2024-11-01
- 9.0.4 — 2024-10-19
- 9.0.3 — 2024-10-19
- 9.0.2 — 2024-09-25
- 9.0.1 — 2024-09-08
- 9.0.0 — 2024-09-01
- 9.0.0-5 — 2024-08-30
- 9.0.0-4 — 2024-08-30
- 9.0.0-3 — 2024-08-30
- 9.0.0-2 — 2024-08-29
- 9.0.0-1 — 2024-08-29
- … 122 more at https://npm.io/package/jsdoc-to-markdown/versions

## README

[![view on npm](https://badgen.net/npm/v/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown)
[![npm module downloads](https://badgen.net/npm/dt/jsdoc-to-markdown)](https://www.npmjs.org/package/jsdoc-to-markdown)
[![Gihub repo dependents](https://badgen.net/github/dependents-repo/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=REPOSITORY)
[![Gihub package dependents](https://badgen.net/github/dependents-pkg/jsdoc2md/jsdoc-to-markdown)](https://github.com/jsdoc2md/jsdoc-to-markdown/network/dependents?dependent_type=PACKAGE)
[![Node.js CI](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml/badge.svg)](https://github.com/jsdoc2md/jsdoc-to-markdown/actions/workflows/node.js.yml)

_Upgraders, please read the [release notes](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)_

# jsdoc-to-markdown

Generates markdown API documentation from [jsdoc](https://jsdoc.app) annotated source code. Useful for injecting API docs into project README files.

## Synopsis

1\. Document your code using valid jsdoc comments.

```js
/**
 * A quite wonderful function.
 * @param {object} - Privacy gown
 * @param {object} - Security
 * @returns {survival}
 */
function protection (cloak, dagger) {}
```

2\. Run a command.

```sh
$ jsdoc2md example.js
```

3\. Get markdown output.

```markdown
## protection(cloak, dagger) ⇒ <code>survival</code>
A quite wonderful function.

**Kind**: global function

| Param  | Type                | Description  |
| ------ | ------------------- | ------------ |
| cloak  | <code>object</code> | Privacy gown |
| dagger | <code>object</code> | Security     |

```

## Install

```
$ npm install --save-dev jsdoc-to-markdown
```

## See also

* [API documentation](https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md)
* The [wiki](https://github.com/jsdoc2md/jsdoc-to-markdown/wiki) for example output, FAQs, tutorials, plugins, use with gulp/grunt etc.

* * *

&copy; 2014-25 Lloyd Brookes \<opensource@75lb.com\>.

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