# documentationjs/documentation

:book: documentation for modern JavaScript

Repository: https://github.com/documentationjs/documentation
Canonical: https://ross.abutalabs.com/products/documentation
Homepage: http://documentation.js.org/
Language: JavaScript
License: NOASSERTION
License Family: other
Topics: documentation-tool, documentation, jsdoc, javascript, babel
Last push: 2025-04-15T18:50:26+00:00

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

## Adoption (not part of the score)
Stars 5799, forks 481 (observed 2026-08-28T04:09:29.724673+00:00)

## What it is
documentation.js is a documentation generator for modern JavaScript that reads JSDoc-annotated source (ES5 through ES2017+, JSX, Vue, Flow) and infers parameters, types, and membership. It outputs customizable HTML, Markdown, or JSON via a CLI, Node API, or Gulp/Grunt integration.

## Use cases
- generate api documentation from jsdoc comments
- build html docs site for a javascript library
- generate markdown api docs for readme
- lint jsdoc syntax in my code
- extract documentation as json
- document a vue or flow-typed codebase

## When to choose
- you write JSDoc comments and want polished HTML, Markdown, or JSON output
- you need support for modern JS syntax, JSX, Vue, or Flow type annotations
- you want inferred parameter and type info to reduce manual doc effort
- you want GitHub source links embedded in generated docs

## When to avoid
- your project is not JavaScript or a JS-superset language
- you need a fully active project with frequent releases - it is in maintenance mode
- you want doc tests or executable documentation examples rather than reference docs

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

## Member repositories
- documentationjs/documentation (main) score 30

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:09:29.724673+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:52:46.484338+00:00, confidence not recorded.
  - readme: https://github.com/documentationjs/documentation (fetched 2026-08-28T04:09:29.724673+00:00, sha 5148e279ef19)
  - homepage: http://documentation.js.org/ (fetched 2026-08-29T08:48:11.409073+00:00, sha 356c6b83d0c1)
- Data as of 2026-08-30T08:39:29.467469+00:00.