Compodoc
Documentation tool that generates static documentation from the source of Angular applications and libraries.
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.
Identity
- Status
- Active
- Maintainer
- Vincent Ogloblinsky3
Rendering and deploy
- Runs as
- Static files, Dev only13
- Rendering
- Static output3
- Install with
- npm install -g @compodoc/compodoc4
Releases
Adoption
Sources
- 2026-10-22: links, Runs as
compodoc.app - 2026-10-22: links, Written in, License, GitHub stars
api.github.com/repos/compodoc/compodoc - 2026-10-22: links, Maintainer, Categories, Rendering, Runs as
compodoc.github.io/website/guides/getting-started.html - 2026-10-22: Runtime, Minimum runtime, Install with
compodoc.github.io/website/guides/installation.html - 2026-10-22: License model
github.com/compodoc/compodoc/blob/master/LICENSE - 2026-10-22: Current major version
registry.npmjs.org/@compodoc/compodoc/latest - 2026-10-22: Last release
api.github.com/repos/compodoc/compodoc/releases/latest - 2026-10-22: Contributors
api.github.com/repos/compodoc/compodoc/contributors?anon=true&per_page=100 - 2026-10-22: npm downloads a week
api.npmjs.org/downloads/point/last-week/@compodoc/compodoc - 2026-10-25: Dependent repositories, Dependent packages
packages.ecosyste.ms/api/v1/registries/npmjs.org/packages/%40compodoc%2Fcompodoc