Typedoc 是一款针对 TypeScript 项目自动生成文档的工具，可以根据代码的注释生成文档，并支持多种主题风格，能够生成各种格式的文档，如 HTML、Markdown、JSON 等。下面将介绍 Typedoc 的使用和配置说明。
安装
全局安装 Typedoc：
npm install -g typedoc
局部安装 Typedoc：
npm install typedoc --save-dev
使用
使用 Typedoc 相当简单，只需在项目根目录下执行以下命令即可：
typedoc
该命令会自动解析项目中的 .ts 文件，生成文档，并将其保存在 docs 文件夹中。
默认情况下，Typedoc 会将项目中的所有模块，类，接口，函数以及成员文档化。但如果你想只选择一些指定的模块进行文档生成，可以使用 --include 参数，如下所示：
typedoc --include src
该命令会只生成 src 目录下的代码的文档。
配置
Typedoc 提供了很多可配置选项，你可以在 tsconfig.json 文件中配置 Typedoc。下面是一些常用的选项：
必选选项
outDir：文档输出目录。include：要生成文档的文件或文件夹。exclude：不需要生成文档的文件或文件夹。
下面是一个示例：
{
"compilerOptions": {
"target": "es5",
"module": "commonjs"
},
"include": ["src/**/*"],
"exclude": ["node_modules", "**/*.spec.ts"],
"typedocOptions": {
"outDir": "docs",
"includeDeclarations": true,
"excludeExternals": true,
"excludePrivate": true
}
}
可选选项
name：文档名称。mode：文档模式。（file/class/module）includeDeclarations：是否包括声明文件。excludeExternals：是否排除外部模块。excludePrivate：是否排除私有成员。excludeProtected：是否排除受保护的成员。externalPattern：需要排除的外部模块的正则表达式。readme：README 文件路径。version：文档版本。theme：文档主题。hideGenerator：是否隐藏文档生成器的标签。entryPoint：生成文档的入口点（可以是任何导出了的类或函数）。
主题
Typedoc 支持多种主题，你可以从 Typedoc 主题列表 中选择一个适合你的项目的主题。安装主题方法如下：
npm install --save-dev typedoc-default-themes
默认情况下，Typedoc 使用“default”主题生成文档。如果你想使用其他主题，可以使用以下选项：
{
"typedocOptions": {
"theme": "path/to/theme"
}
}
以 minimal 主题 为例：
npm install --save-dev typedoc-minimal-theme
然后在 tsconfig.json 文件中设置：
{
"typedocOptions": {
"theme": "node_modules/typedoc-minimal-theme/dist"
}
}