文档

Compodoc 是一个用于 Angular 应用的文档工具。由于 Nest 和 Angular 共享相似的项目结构与代码结构，因此 Compodoc 同样适用于 Nest 应用。

安装

在现有 Nest 项目中配置 Compodoc 非常简单。首先，在操作系统终端中使用以下命令添加开发依赖：

$ npm i -D @compodoc/compodoc

生成

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

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

打开浏览器并访问 http://localhost:8080。你应该会看到一个初始的 Nest CLI 项目：

参与贡献

你可以在这里参与并为 Compodoc 项目做贡献。