<img src="https://saucelabs.com/browser-matrix/compodoc.svg" alt="saucelabs badge"/>






<a href="https://gitter.im/compodoc/compodoc" target="_blank"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter badge"/></a>

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

🎖 Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor

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.

vogloblinsky	manekinekko	tcorral	mattlewis92	JonasMH	rprotsyk	daniele-zurico

profimedica	dp-1a	ValentinGot	Blake Simmon	Brigitte Hofmeister	lichangfeng	guilhermevrs

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

License

Everything in this repository is licensed under the MIT License unless otherwise specified.

Copyright (c) 2016 – 2025 Vincent Ogloblinsky