# jsdoc2md/jsdoc-to-markdown

Generate markdown documentation from jsdoc-annotated javascript

Repository: https://github.com/jsdoc2md/jsdoc-to-markdown
Canonical: https://ross.abutalabs.com/products/jsdoc-to-markdown
Language: JavaScript
License: MIT
License Family: permissive
Topics: jsdoc, markdown, jsdoc-to-markdown, api-documentation, generator, documentation, documentation-tool, documentation-generator, readme
Last push: 2025-10-03T14:58:31+00:00

## Health v2 (maintenance only)
Score: 58/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 45, release rhythm 50, longevity 100
- inputs: {"age_days": 4493, "days_push": 334, "days_rel": 334, "gap_med": 23, "n_releases_24m": 8}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1758, forks 150 (observed 2026-08-28T04:05:32.372670+00:00)

## What it is
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
- artifact type: cli-tool
- maturity: active
- function: documentation, api-documentation, cli, markdown
- domain: documentation, developer-tools
- platform: cli, cross-platform
- tags: jsdoc, markdown-generator, readme, api-docs, javascript, nodejs

## Member repositories
- jsdoc2md/jsdoc-to-markdown (main) score 58

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:32.372670+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T03:27:34.703740+00:00, confidence not recorded.
  - readme: https://github.com/jsdoc2md/jsdoc-to-markdown (fetched 2026-08-28T04:05:32.372670+00:00, sha 046e66db0803)
  - registry_npm: https://registry.npmjs.org/jsdoc-to-markdown (fetched 2026-08-29T11:06:01.031707+00:00, sha 9d8110d6e57d)
- Data as of 2026-08-30T08:39:29.467469+00:00.