前言
@gnucoop/typedoc-theme 是一个用于生成 TypeScript API 文档的 TypeDoc 主题。使用该主题可以生成美观而又富有指导意义的文档。本教程将介绍如何使用该包来生成文档，并且带有相应的示例代码。
准备
安装 TypeDoc
要使用 @gnucoop/typedoc-theme 主题，你需要先安装 TypeDoc 工具。可以使用以下命令进行全局安装：
npm install -g typedoc
安装 @gnucoop/typedoc-theme
要使用该主题，需要先安装它。使用以下命令进行安装：
npm install @gnucoop/typedoc-theme
使用
生成文档
使用以下命令，可以生成 TypeScript API 文档：
typedoc --out docs ./src
其中，docs 是生成的文档存放目录，./src 是源代码目录。
使用主题
要使用 @gnucoop/typedoc-theme，需要在 TypeDoc 命令中添加 --theme @gnucoop/typedoc-theme 参数：
typedoc --out docs --theme @gnucoop/typedoc-theme ./src
这样就可以生成该主题的文档了。
配置
该主题提供了许多定制的选项，可以通过 typedoc.json 文件进行配置。例如：
-- -------------------- ---- ------- - ------- --- --------- ---------- ---------------------- ------ --------- -------- ------------------------- --------- -------------- ----------- -------- ------------------- ----- ----------------- ----- ------------------- ----- ---------------- ----- ---------------- ----- ---------------- -------------------- ---------- --------------- -
其中，每个选项的含义如下：
name：项目名称。exclude：排除某些源文件，可以使用通配符。out：文档生成目录。theme：使用的主题名称。readme：项目的README文件路径。includes：包含的源代码目录。excludeExternals：是否排除外部模块的文档。excludePrivate：是否排除私有成员的文档。excludeProtected：是否排除受保护成员的文档。stripInternal：是否屏蔽内部标记的成员。hideGenerator：是否隐藏TypeDoc生成器信息。entryDocument：入口文档文件路径。sitemap：站点地图文件路径。
示例代码
以下是在 TypeScript 项目中的 typedoc.json 配置示例：
-- -------------------- ---- ------- - ------- --- --------- ------ --------- -------- ------------------------- ----------- -------- ------------------- ----- ----------------- ----- ---------------- ----- ---------------- ---- -
这个示例配置将项目名称设置为 My Project，生成文档存放在 ./docs 目录下，使用 @gnucoop/typedoc-theme 主题，包含源代码目录 ./src，排除外部模块文档，排除私有成员文档，屏蔽内部标记成员，隐藏 TypeDoc 生成器信息。
结论
@gnucoop/typedoc-theme 主题是一个很好用的 TypeDoc 主题。使用这个主题可以生成美观而又富有指导意义的文档。本文介绍了如何使用它并提供了示例代码。希望这篇文章能够帮助到你生成更好的 TypeScript API 文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005642d81e8991b448e159c