Compodoc — Documentation tool for Angular

Posted by Christian Weiß on December 10, 2018

Compodoc

What is Compodoc

Documentation generator for Angular Appliations. It generates a static documentation of your application.

The goal of the tool is to generate a documentation for all the common APIs of Angular : modules, components, injectables, routes, directives, pipes and classical classes.

Get Compodoc

Homepage: https://compodoc.app

Installation

Install from npm :

npm install -g @compodoc/compodoc

Run

Define a script task for it in your package.json:

"scripts": {
  "compodoc": "./node_modules/.bin/compodoc -p src/tsconfig.app.json"
}

Change to your project root folder and run it like a normal npm script:

npm run compodoc

See usage for more details.

After some logs in the console, you got the generated documentation in the ./documentation/ folder at the root of your project folder.

Open the index.html in your browser.