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.

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.


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



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