Compodoc
Compodoc est un outil open-source permettant de générer rapidement une documentation de votre application Angular.

Installation

La commande suivante installe le module @compodoc/compodoc.
1
yarn add --dev @compodoc/compodoc
Copied!

Utilisation

Définissez ensuite un npm "script" dans votre fichier package.json
1
"scripts": {
2
"compodoc": "compodoc -p src/tsconfig.app.json"
3
}
Copied!
Et lancez la ensuite dans votre terminal :
1
yarn compodoc
Copied!
Vous obtiendrez ensuite la documentation générée dans le dossier documentation. Ouvrez la dans votre navigateur préféré.

Example

Un example de documentation générée est disponible sur ce lien : https://compodoc.github.io/compodoc-demo-todomvc-angular/

Remerciement

Merci à Vincent OGLOBLINSKY pour sa contribution !
vogloblinsky - Overview
GitHub
Dernière mise à jour 3yr ago