Getting started

What is Compodoc ?

Compodoc is a documentation tool for Angular applications. It generates a static documentation of your application.

Why Use Compodoc ?

Compodoc helps Angular developers providing a clear and helpful documentation of their application.

Others developers of your team, or internet visitors for a public documentation, can easily understand the features of your application or library.

Version support

Dated january 2025, Compodoc is compatible with Angular 19 and standalone components, with limitations on routing support. There is a work in progress to support standalone components routing for graph generation.

Open Source

Compodoc is an open source effort from Vincent Ogloblinsky.

Developers can contribute and fork the repo on GitHub.

Don't forget to read the Contributing guide.

Ready ? Go !

Read the installation page for details on installation. The usage helps you with all the options available.

Backers

Support us with a monthly donation and help us continue our activities. Become a backer