# TypeStrong/typedoc

Documentation generator for TypeScript projects.

Repository: https://github.com/TypeStrong/typedoc
Canonical: https://ross.abutalabs.com/products/typedoc
Homepage: https://typedoc.org
Language: TypeScript
License: Apache-2.0
License Family: permissive
Topics: typescript, documentation, generator
Last push: 2026-07-13T01:33:41+00:00

## Health v2 (maintenance only)
Score: 94/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 92, release rhythm 92, longevity 100
- inputs: {"age_days": 4484, "days_push": 52, "days_rel": 59, "gap_med": 13, "n_releases_24m": 36}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 8447, forks 773 (observed 2026-08-28T04:10:21.218570+00:00)

## What it is
TypeDoc is a documentation generator for TypeScript projects that converts source code comments into HTML documentation sites or a JSON model. It runs on Node.js as an npm package and supports theming and a plugin API.

## Use cases
- generate api documentation from typescript source code
- build html docs for a typescript library
- document a typescript monorepo with multiple packages
- export a json model of a typescript project's api
- customize documentation output with themes and plugins

## When to choose
- you maintain a TypeScript library or application and want API docs generated from source comments
- you need documentation for monorepos with multiple npm packages
- you want a JSON representation of your project's type structure for tooling

## When to avoid
- your project is not written in TypeScript
- you need hand-authored narrative documentation rather than API reference docs
- you need runtime-hosted documentation sites with live search backends

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, parser, cli, static-site-generator, api-documentation
- domain: developer-tools, documentation, web-development, programming-languages
- platform: cli, cross-platform
- tags: typescript, api-docs, doc-generator, npm-package, monorepo-support, nodejs

## Member repositories
- TypeStrong/typedoc (main) score 94

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:10:21.218570+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:27:12.994018+00:00, confidence not recorded.
  - readme: https://github.com/TypeStrong/typedoc (fetched 2026-08-28T04:10:21.218570+00:00, sha 506cb39873e4)
  - homepage: https://typedoc.org (fetched 2026-08-29T08:27:18.434548+00:00, sha 47f4117ef4df)
- Data as of 2026-08-30T08:39:29.467469+00:00.