Documentation

Compodoc est un outil de documentation pour les applications Angular. Étant donné que Nest et Angular partagent des structures de projet et de code similaires, Compodoc fonctionne également avec les applications Nest.

Configuration

Configurer Compodoc dans un projet Nest existant est très simple. Commencez par ajouter la dépendance de développement avec la commande suivante dans votre terminal OS :

$ npm i -D @compodoc/compodoc

Génération

Générez la documentation du projet en utilisant la commande suivante (npm 6 est requis pour le support de npx). Consultez la documentation officielle pour plus d’options.

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

Ouvrez votre navigateur et accédez à http://localhost:8080.

Contribuer

Vous pouvez participer et contribuer au projet Compodoc ici.