Compodoc Documentation

Compodoc是 Angular 应用程序的文档工具。由于 Nest 和 Angular 共享类似的项目和代码结构，因此 Compodoc 也适用于 Nest 应用程序。

设置

在现有 Nest 项目中设置 Compodoc 非常简单。首先在 OS 终端中使用以下命令添加 dev-dependency：

bash
$ npm i -D @compodoc/compodoc

生成

使用以下命令生成项目文档（npm 6 需要 npx 支持）。请参阅官方文档 了解更多选项。

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

打开浏览器并导航至 http://localhost:8080。您应该会看到一个初始 Nest CLI 项目：

imgimg

Contribute

您可以在 此处 参与并为 Compodoc 项目做出贡献。