Documentation

Compodoc is a documentation tool for Angular applications. Since Nest and Angular share similar project and code structures, Compodoc works with Nest applications as well.

Setup#

Setting up Compodoc inside an existing Nest project is very simple. Start by adding the dev-dependency with the following command in your OS terminal:

$ npm i -D @compodoc/compodoc

Generation#

Generate project documentation using the following command (npm 6 is required for npx support). See the official documentation for more options.

$ npx @compodoc/compodoc -p tsconfig.json -s

Open your browser and navigate to http://localhost:8080. You should see an initial Nest CLI project:

Contribute#

You can participate and contribute to the Compodoc project here.