# tj/dox

JavaScript documentation generator for node using markdown and jsdoc

Repository: https://github.com/tj/dox
Canonical: https://ross.abutalabs.com/products/dox
Language: JavaScript
License Family: other
Last push: 2022-09-07T14:50:30+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 5915, "days_push": 1456, "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 2151, forks 196 (observed 2026-08-28T04:06:19.354761+00:00)

## What it is
Dox is a JavaScript documentation generator for Node.js that parses JSDoc-style comments and markdown to produce a JSON representation of your code's documentation. It is unopinionated about output format, letting you render the JSON with your own templates.

## Use cases
- generate JSON documentation data from JSDoc comments
- parse jsdoc comments in javascript files
- build custom documentation sites from source comments
- extract api docs from node modules
- convert markdown and jsdoc comments into structured
- pipe source files through a cli to get doc metadata

## When to choose
- you want raw structured documentation data rather than a fixed HTML output
- you need to build custom templates or pipelines on top of JSDoc comments
- you prefer a lightweight stdio-based CLI for doc extraction

## When to avoid
- you want a complete documentation site generator with built-in themes
- you need active development or guaranteed maintenance
- you document non-JavaScript languages

## Facets
- artifact type: library
- maturity: maintenance
- function: documentation, parser
- domain: documentation, developer-tools
- platform: cli
- tags: jsdoc, markdown, doc-generator, -output, javascript, nodejs

## Member repositories
- tj/dox (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:06:19.354761+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:50:56.812757+00:00, confidence not recorded.
  - readme: https://github.com/tj/dox (fetched 2026-08-28T04:06:19.354761+00:00, sha a323ece3351d)
- Data as of 2026-08-30T08:39:29.467469+00:00.