# compodoc/compodoc

:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application

Repository: https://github.com/compodoc/compodoc
Canonical: https://ross.abutalabs.com/products/compodoc
Homepage: https://compodoc.app
Language: TypeScript
License: MIT
License Family: permissive
Topics: angular, documentation-tool, typescript, documentation, jsdoc, devtools, angular2, generator, ast
Last push: 2026-08-26T16:33:11+00:00

## Health v2 (maintenance only)
Score: 96/100 (v2, computed 2026-09-02T17:46:02.011165+00:00)
- activity 99, release rhythm 90, longevity 100
- inputs: {"age_days": 3607, "days_push": 7, "days_rel": 66, "gap_med": 27, "n_releases_24m": 10}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 4120, forks 411 (observed 2026-08-28T04:08:35.942392+00:00)

## What it is
Compodoc is a documentation generator for Angular, NestJS, and Stencil applications that parses TypeScript source code (without compilation) to produce static documentation sites. It includes themes, a lunr.js search engine, route/dependency graphs, documentation coverage reports, and LLM-ready structured export.

## Use cases
- generate documentation for an Angular application
- document a NestJS project
- create API docs from TypeScript source
- get a documentation coverage report for my codebase
- generate route and dependency graphs for Angular modules
- produce static docs searchable offline
- export structured docs for LLM processing

## When to choose
- you have an Angular, NestJS, or Stencil project needing API documentation
- you want a local, offline documentation tool with no server or uploads
- you want JSDoc-style comments rendered into a themed static site
- you need documentation coverage metrics for your team

## When to avoid
- your project is not Angular, NestJS, or Stencil based
- you need docs for plain JavaScript without TypeScript
- you want a hosted/live documentation service rather than generated static files

## Facets
- artifact type: cli-tool
- maturity: active
- function: documentation, static-site-generator, search-engine, parser
- domain: documentation, web-development, developer-tools
- platform: cli, cross-platform
- tags: angular, nestjs, stencil, typescript, jsdoc, static-docs, api-reference, llm-export, nodejs

## Member repositories
- compodoc/compodoc (main) score 96

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:35.942392+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-29T18:23:07.042954+00:00, confidence not recorded.
  - readme: https://github.com/compodoc/compodoc (fetched 2026-08-28T04:08:35.942392+00:00, sha 01f6f07cecca)
  - homepage: https://compodoc.app (fetched 2026-08-29T09:14:37.414611+00:00, sha 99d6c80fafa7)
  - site_page: https://compodoc.app/guides/features.html (fetched 2026-08-29T09:14:37.417209+00:00, sha a8a59894a7dd)
  - site_page: https://compodoc.app/guides/getting-started.html (fetched 2026-08-29T09:14:37.418794+00:00, sha 516f3ec5fbcf)
  - registry_npm: https://registry.npmjs.org/compodoc (fetched 2026-08-29T09:14:37.420632+00:00, sha ed9b6f5792ec)
- Data as of 2026-08-30T08:39:29.467469+00:00.