Documentation

Compodoc is a documentation tool for Angular applications. Nest and Angular look very similar, hence, Compodoc supports Nest applications as well.

Setup

Setting up Compodoc inside an existing Nest project is very simple. With npm installed, just add the dev-dependency with the following command in your OS terminal:

  1. $ npm i -D @compodoc/compodoc

Generation

Following the official documentation, you can generate your documentation using the below command (npm 6 required):

  1. $ npx compodoc -p tsconfig.json -s

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

Documentation - 图1Documentation - 图2

Contribute

You can participate and contribute to the Compodoc project here.