# esdoc/esdoc

ESDoc - Good Documentation for JavaScript

Repository: https://github.com/esdoc/esdoc
Canonical: https://ross.abutalabs.com/products/esdoc
Homepage: https://esdoc.org
Language: JavaScript
License: MIT
License Family: permissive
Topics: esdoc, javascript, es2015, ast, jsdoc
Last push: 2024-08-14T11:10:32+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 4176, "days_push": 749, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 2731, forks 199 (observed 2026-08-28T04:07:16.099397+00:00)

## What it is
ESDoc is a documentation generator for JavaScript that produces static HTML API docs from doc comments, targeting ES2015 class and module syntax. It measures documentation coverage, integrates test code and manuals into docs, and is extensible via a plugin architecture.

## Use cases
- generate api documentation for an es6 javascript library
- measure documentation coverage of my codebase
- integrate test code into api docs
- generate html docs from jsdoc-style comments
- document es2015 classes without writing many tags
- host javascript api documentation online

## When to choose
- your codebase uses ES2015 class and module syntax
- you want documentation coverage metrics and test integration
- you prefer fewer tags thanks to syntax-aware parsing

## When to avoid
- your code is prototype-based or ES3/ES5 style
- you need a tool with frequent updates and modern ecosystem support
- you need first-class TypeScript support

## Facets
- artifact type: cli-tool
- maturity: maintenance
- function: documentation, parser, developer-tools
- domain: developer-tools, documentation, web-development
- platform: cli, cross-platform
- tags: api-docs, es2015, jsdoc-alternative, doc-coverage, static-html-output, javascript, nodejs

## Member repositories
- esdoc/esdoc (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:16.099397+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-30T02:14:39.637531+00:00, confidence not recorded.
  - readme: https://github.com/esdoc/esdoc (fetched 2026-08-28T04:07:16.099397+00:00, sha 7efff5b6d7e9)
  - homepage: https://esdoc.org (fetched 2026-08-29T09:58:10.395128+00:00, sha fa47aff45077)
  - registry_npm: https://registry.npmjs.org/esdoc (fetched 2026-08-29T09:58:10.416681+00:00, sha b89473165e0e)
  - site_page: https://esdoc.org/manual/feature.html (fetched 2026-08-29T09:58:10.405477+00:00, sha e63b6604eec7)
  - site_page: https://esdoc.org/manual/CHANGELOG.html (fetched 2026-08-29T09:58:10.407661+00:00, sha 70767f72cc5f)
  - site_page: https://esdoc.org/manual/faq.html (fetched 2026-08-29T09:58:10.409978+00:00, sha 875f7a1812d3)
  - site_page: https://esdoc.org/manual/usage.html (fetched 2026-08-29T09:58:10.412207+00:00, sha e4dd6736bd14)
  - site_page: https://esdoc.org/v0.5/index.html (fetched 2026-08-29T09:58:10.414070+00:00, sha 5b5161e85a48)
- Data as of 2026-08-30T08:39:29.467469+00:00.