在前端开发过程中，文档编写是必不可少的一环节。而 TypeScript 项目中，typedoc 是一款非常好用的文档生成工具。但是默认生成的 html 格式文档并不美观，这时候就需要借助 typedoc-md-theme 这个 npm 包来优化文档效果。
步骤一：安装 typedoc-md-theme
使用 npm 安装 typedoc-md-theme：
npm install typedoc-md-theme --save-dev
步骤二：生成文档
在项目中执行以下命令，生成 markdown 格式的文档：
typedoc --theme node_modules/typedoc-md-theme/bin --out docs src
其中，--theme 指定主题，--out 指定输出目录，src 是你的代码目录。
步骤三：配置 typedoc.json
修改项目中的 typedoc.json 配置文件，指定输出 markdown 格式的文档：
-- -------------------- ---- ------- - ------ ------- ------- ------- - -------- ----------- --------- ------ ---------- -------------------- --------- ------- -------- ------------------------------------ -------------- ----------------- ------------------- ----- ----------------- ----- ----------------- ----- ---------------- ----- ------- --- -------- -
其中，theme 指定了使用的主题。
示例代码
-- -------------------- ---- -------
---
- - -------
--
------ ----- ------ -
---
- --- --- -- --- -------
--
---- -------
---
- --- ---- -- --- -------
- ------ ---- - --- ---- -- --- --- --- -------
--
------------------ ----- ------- --
---
- --- ----- -- --- -------
- ------ -- - --- ------ -- --- ----- ---
--
------------ -------- ------ -
------ ------- ----------- --- ---------------
-
-结语
以上就是如何使用 typedoc-md-theme 生成 markdown 格式的文档的详细步骤，使用起来非常简单，只需要安装 npm 包即可。生成的文档更美观，也方便团队协作。建议在项目中使用，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005536f81e8991b448d0a27
