# Compodoc

Documentation tool that generates static documentation from the source of Angular applications and libraries.


Source: https://findsoftware.frbit.cloud/compodoc/
Last reviewed: 2026-10-22
Updated: 2026-10-25
Listed since: 2026-10-22

## Record

### Links

- home: https://compodoc.app
- repository: https://github.com/compodoc/compodoc
- docs: https://compodoc.github.io/website/guides/getting-started.html

### Identity

- status: active
- maintainer: Vincent Ogloblinsky
- maintainerType: unknown
- parent: unknown
- firstRelease: unknown
- hqCountry: unknown

### Kind

- category: ssg
- hosting: static
- language: javascript
- runtime: node
- runtimeMin: node 20
- basedOn: unknown

### Content

- contentStore: unknown
- databases: unknown
- adminUi: unknown
- headlessApi: unknown
- templating: unknown
- i18n: unknown

### Rendering and deploy

- runsAs: static, local
- renderingModes: static
- installMethod: npm install -g @compodoc/compodoc

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 2
- latestReleaseDate: 2026-06-28

### Adoption

- githubStargazers: 4119
- packagistDownloads: not applicable
- npmWeeklyDownloads: 334990
- contributors: 72
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: 9141
- dependentPackages: 1965

### Sources

- urls: https://compodoc.app (read 2026-10-22)
- urls: https://api.github.com/repos/compodoc/compodoc (read 2026-10-22)
- urls: https://compodoc.github.io/website/guides/getting-started.html (read 2026-10-22)
- maintainer: https://compodoc.github.io/website/guides/getting-started.html (read 2026-10-22)
- category: https://compodoc.github.io/website/guides/getting-started.html (read 2026-10-22)
- language: https://api.github.com/repos/compodoc/compodoc (read 2026-10-22)
- runtime: https://compodoc.github.io/website/guides/installation.html (read 2026-10-22)
- runtimeMin: https://compodoc.github.io/website/guides/installation.html (read 2026-10-22)
- installMethod: https://compodoc.github.io/website/guides/installation.html (read 2026-10-22)
- renderingModes: https://compodoc.github.io/website/guides/getting-started.html (read 2026-10-22)
- runsAs: https://compodoc.github.io/website/guides/getting-started.html (read 2026-10-22)
- runsAs: https://compodoc.app (read 2026-10-22)
- license: https://api.github.com/repos/compodoc/compodoc (read 2026-10-22)
- licenseModel: https://github.com/compodoc/compodoc/blob/master/LICENSE (read 2026-10-22)
- currentMajor: https://registry.npmjs.org/@compodoc/compodoc/latest (read 2026-10-22)
- latestReleaseDate: https://api.github.com/repos/compodoc/compodoc/releases/latest (read 2026-10-22)
- githubStargazers: https://api.github.com/repos/compodoc/compodoc (read 2026-10-22)
- contributors: https://api.github.com/repos/compodoc/compodoc/contributors?anon=true&per_page=100 (read 2026-10-22)
- npmWeeklyDownloads: https://api.npmjs.org/downloads/point/last-week/@compodoc/compodoc (read 2026-10-22)
- dependentRepos: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/%40compodoc%2Fcompodoc (read 2026-10-25)
- dependentPackages: https://packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/%40compodoc%2Fcompodoc (read 2026-10-25)

## Notes

Compodoc is a documentation tool for Angular applications that generates static documentation from a project's source. It runs as a local tool: the project's homepage says no server is needed and no sources are uploaded online. A developer installs it from npm with the global install command. Its output is static, and the hosting guide gives GitHub Pages as an example of where it can be published.

## Worth knowing

The package was published under the name compodoc until it moved to @compodoc/compodoc, and the old name is deprecated with a notice pointing to the new one. The homepage names Nest and Stencil next to Angular, while the guides describe Angular projects only.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0