简介
typedoc-markdown-theme 是一个将 TypeScript 代码文档转换成 Markdown 格式的工具。该工具允许使用 Markdown 样式将 TypeScript 代码文档呈现为易于阅读和具有层次结构的文档。
安装
在安装之前，确保已安装 TypeDoc 工具。
使用以下命令安装 typedoc-markdown-theme：
--- ------- ---------- ------- ----------------------
使用方法
使用 typedoc-markdown-theme 转换 TypeDoc 生成的文档非常简单。首先，在你的 TypeScript 项目中创建 typedoc.json 文件。在该文件中指定 TypeDoc 的配置选项。以下是一个示例：
- ------- ------------- ------- ------- ------ --------- -------- -------------------------------------- ------------------- ----- ----------------- ----- ------------------- ----- ---------------------- ----- -
在 out 配置选项中指定输出目录。
现在，在命令行中输入以下命令：
------- -------- ------------
运行完该命令后，会在项目的指定输出目录中生成 Markdown 格式的文档。
主题自定义
typedoc-markdown-theme 允许用户自定义主题。为了自定义主题，首先需要创建一个新的 theme 文件夹，然后添加用于自定义主题的样式文件。
在自定义主题中，可以覆盖默认样式，并添加新的样式。
样式自定义
有两种方法可以自定义样式：覆盖默认样式和添加新样式。
覆盖默认样式
要覆盖默认样式，可以在自定义主题中创建一个新的 CSS 文件，并在 HTML 模板中使用它。例如，以下是在 HTML 模板中使用名为 custom-style.css 的自定义样式文件的示例：
----- ---------------- ------------------------
添加新样式
要添加新样式，可以在自定义主题中创建一个新的 CSS 文件，并在 HTML 模板中使用它。例如，以下是在 HTML 模板中使用名为 custom-style.css 的新样式文件的示例：
----- ---------------- ------------------------
HTML 模板自定义
在 typedoc-markdown-theme 中，可以使用自定义 HTML 模板来自定义主题。为此，在自定义主题中创建新的 HTML 模板，并在 TypeDoc 配置文件中引用它。例如，以下是一个示例：
- ------- ------------- ------- ------- ------ --------- -------- -------------------------------------- ----------- ---------------------- ------------------- ----- ----------------- ----- ------------------- ----- ---------------------- ----- -
在该配置文件中，指定新的 HTML 模板文件名称；在本示例中，模板文件名为 custom-template.hbs。
默认模板的源代码可在 npm 包源代码的 templates/ 文件夹中找到。该文件夹包含以下文件：
- layout.hbs - 包含 HTML 布局的模板。
- index.hbs - 包含文档首页的模板。
- model.hbs - 包含类型、函数和接口的文档页的模板。
- parameter.hbs - 包含函数参数的文档页的模板。
- property.hbs - 包含类属性的文档页的模板。
示例代码
以下是一个 TypeScript 代码示例：
---
- ---- -- - ----- ------
--
------ ----- ----- -
---
- ------ - - ----------
- ------ - - ----------
--
------------------ -- ------- ------ -- ------- --
---
- --- - ----- -- ---- ------
- ------ ----- --- ----- -- ----
--
---------- ------- ----- -
------ --- ------------ - -------- ------ - ---------
-
-生成的 Markdown 文档大致如下所示：
--- ----- ---- -- - ----- ------ ---- ----------- ------------------- -- ------- ------ -- -------- ----- ---------- - ---- - ---- - ----------- - - ---- - ---- - ----------- - - - - ------ - - ---------- - - - - ------ - - ---------- - ---- --- --- - ----- -- ---- ------ ----------- ------- ------ ----- ---------- - ---- - ---- - ----------- - - ---- - ---- - ----------- - - ----- - ----- - --- ----- -- ---- - ----- ------- ----- ----- ------- ------------- ----- ------ - --- -------- --- ----- ------ - --- -------- --- ----- ------ - ------------------- -------------------------- --------------- -- --- --
------------- -------- ------------- ------------------------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------------------------------------------