jsdoc2md/jsdoc-to-markdown

Health v2 · maintenance only

Adoption not part of the score

1760 stars · 150 forks observed · 2026-10-19

What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded

A Node.js CLI tool and library that generates markdown API documentation from jsdoc-annotated JavaScript source code. It is commonly used to inject API docs directly into project README files.

Use cases

• generate markdown docs from jsdoc comments
• inject API documentation into a README
• convert jsdoc-annotated javascript to markdown
• document a javascript library's API
• automate API docs generation in CI
• produce markdown reference docs for npm packages

When to choose

• your code is already documented with jsdoc comments and you want markdown output
• you want API docs embedded in your README or docs site
• you need a scriptable, CI-friendly documentation generator for JavaScript

When to avoid

• you use TypeScript and prefer typedoc-style output
• you want HTML documentation sites rather than markdown
• your codebase is not documented with jsdoc annotations

Facets

cli-tool · maturity active

documentation api-documentation cli markdown documentation developer-tools cli cross-platform jsdoc markdown-generator readme api-docs javascript nodejs

Member repositories

For agents

markdown · JSON · MCP: product_card(name="jsdoc2md/jsdoc-to-markdown")