The missing documentation tool for your Angular application.
Live Demo
A live demo is available — see it in action !
The demo features documentation generated for a simple TodoMVC application.
Features
Modern Angular support — Documents standalone APIs, signal inputs and aliases,
styleUrl, injectable metadata, and inheritance details.Standalone-aware routing — Generates route and dependency graphs for
provideRouter, lazy routes, default-export route files, and classic NgModule routing.Complete project documentation — Covers components, directives, pipes, modules, injectables, guards, interceptors, classes, interfaces, and routes.
Automatic table of contents — Builds API navigation from the elements found while parsing your project.
Search — Includes a powerful search engine (lunr.js) for quickly finding documented APIs.
Themes — Ships built-in themes inspired by Gitbook, Read the Docs, Vagrant, Laravel, Postmark, and Stripe.
JSDoc and TypeScript rendering — Handles common JSDoc tags, complex types, inherited docs, examples, custom tags, and richer interface documentation.
Documentation coverage — Generates coverage reports and supports coverage checks for CI workflows.
Offline and developer-friendly output — Supports Angular CLI projects, static offline docs, JSON export, and LLM-ready Markdown output.
Documentation
Official documentation has moved to https://compodoc.github.io/website/.
Installation
Ready to get started? Read installation instructions.
🏅 Backers
Thank you to all our backers ! Support us with a monthly donation and help us continue our activities. [Become a backer][support-url]
[![Backers][backers-image]][support-url]
🎖 Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor][support-url]
[![Sponsors][sponsors-image]][support-url]
Contributing
Want to file a bug, contribute some code, or improve documentation? Excellent!
Read up on our guidelines for contributing.
Contributors
This project exists thanks to all these people.
| 
