# jsdoc/jsdoc

An API documentation generator for JavaScript.

Repository: https://github.com/jsdoc/jsdoc
Canonical: https://ross.abutalabs.com/products/jsdoc
Homepage: https://jsdoc.app/
Language: JavaScript
License: Apache-2.0
License Family: permissive
Topics: jsdoc, javascript, api, docs, documentation
Last push: 2026-08-26T01:54:04+00:00

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

## Adoption (not part of the score)
Stars 15454, forks 1488 (observed 2026-08-28T04:11:09.895843+00:00)

## What it is
JSDoc is an API documentation generator for JavaScript, similar to Javadoc. It parses JSDoc-style comments in source code and generates an HTML documentation website, with support for plugins, templates, and Markdown.

## Use cases
- generate api documentation from jsdoc comments
- create html docs website for a javascript library
- document node.js modules and classes
- convert jsdoc comments to markdown
- add tutorials to api documentation
- customize documentation output with templates

## When to choose
- you maintain a JavaScript or Node.js library and want standard JSDoc-comment-based API docs
- you need a mature, widely supported doc generator with many community templates and build-tool integrations
- you want docs generated directly from source comments without a separate type system

## When to avoid
- you want TypeScript-style typed documentation from type annotations alone (consider TypeDoc)
- you need a modern all-in-one docs site framework with live examples (consider tools like Docusaurus with typedoc)
- your project is not JavaScript-based

## Facets
- artifact type: cli-tool
- maturity: stable
- function: documentation, api-documentation, parser, cli, plugin-system
- domain: developer-tools, documentation, web-development, apis
- platform: cli, cross-platform
- tags: jsdoc, api-docs, doc-comments, html-docs, javascript, nodejs

## Member repositories
- jsdoc/jsdoc (main) score 67

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:11:09.895843+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-29T17:05:50.812793+00:00, confidence not recorded.
  - readme: https://github.com/jsdoc/jsdoc (fetched 2026-08-28T04:11:09.895843+00:00, sha 1b004d7dba93)
  - homepage: https://jsdoc.app/ (fetched 2026-08-29T08:04:22.446912+00:00, sha 1c97d9dce4a6)
  - site_page: https://jsdoc.app/about-getting-started (fetched 2026-08-29T08:04:22.456263+00:00, sha 73e078360c06)
  - site_page: https://jsdoc.app/about-namepaths (fetched 2026-08-29T08:04:22.458230+00:00, sha 2b270014a063)
  - site_page: https://jsdoc.app/about-commandline (fetched 2026-08-29T08:04:22.459800+00:00, sha a83f26213082)
  - site_page: https://jsdoc.app/about-configuring-jsdoc (fetched 2026-08-29T08:04:22.461335+00:00, sha 0a06cc11c590)
  - site_page: https://jsdoc.app/about-configuring-default-template (fetched 2026-08-29T08:04:22.463787+00:00, sha f68b83ca421c)
  - site_page: https://jsdoc.app/about-block-inline-tags (fetched 2026-08-29T08:04:22.466042+00:00, sha 574d3e894fe7)
  - site_page: https://jsdoc.app/about-plugins (fetched 2026-08-29T08:04:22.467654+00:00, sha 7dd45a6beffc)
  - site_page: https://jsdoc.app/about-tutorials (fetched 2026-08-29T08:04:22.469679+00:00, sha d3cf26d689de)
- Data as of 2026-08-30T08:39:29.467469+00:00.