The missing documentation tool for your Angular application

Generate your Angular project documentation in seconds.
Compodoc comes with a lot of features. Check it out now!

Learn more Live demo

Star

Features

Angular friendly

Compodoc supports all major APIs of Angular

Open-source and on npm

Use it directly in your project using npm and one script, that's it !

Local tool

No server needed, no sources uploaded online

Beautiful themes

7 themes are available from famous documentation tools like Gitbook, Read the Docs or projects like Vagrant, Laravel, Postmark and Stripe

Search engine

Compodoc include a powerful search engine (lunr.js) for easily finding your information

Responsive Design

The generated pages display very well on mobile, tablet and desktop

Getting started


                                        # Install compodoc with npm
                                        $ npm install -g @compodoc/compodoc
                                        # Run compodoc in your project and serve it
                                        $ compodoc src -s

The missing documentation tool for your Angular application

Overview page

Module page

Component page

Search page

Source code tab

Documentation coverage page

Features

Angular friendly

Open-source and on npm

Local tool

Beautiful themes

Search engine

Responsive Design

Getting started

Read the documentation for others scenarios.

6 beautiful themes

Gitbook

Laravel

Postmark

Readthedocs

Stripe

Vagrant

They use Compodoc

Angular seed

Angular calendar