typescript - 是否可以使用 TypeDoc 为 TypeScript 项目生成单页文档 html？

Question

假设我的库中有两个 TypeScript 类，名为 SuperBase . Database和 Record .

是否可以使用 TypeDoc 生成 单页下面是非常简单的格式。它不必完全是那样，只是一些简单和相似的东西。

应该是 非常简单和最小 ，只有一页。像你会在 Markdown 自述文件中写自己的东西。它需要做的只是从源中获取这些文档并将其粘贴到单个 HTML 页面中。 TypeDoc 或 是否可行？其他一些工具 typescript ？

(header) SuperBase
(text) description of the package taken from package.json or somewhere else

(header) Database
(text) Description of the database taken from class docs

(subheader) connect(url: string)
(text) description of the connect method taken from method docs

(header) Record
(text) Description of the Record taken from class docs

(subheader) validate()
(text) description of the validate method taken from method docs

Answer 1

您可以使用 typedoc , typedoc-plugin-markdown , showdown 和 concat-md 在一个命令中。结果，你们都有一个单一的页面 Markdown 和 HTML。

(免责声明:我是开源 concat-md 和 readmeasy 的开发人员)

如何

typedoc-plugin-markdown 根据您的 TypeDoc 注释和 concat-md 生成一系列 Markdown 文件从多个 Markdown 文件创建一个文件。

如果您需要进一步定制README.md文件除了包含创建的 API Markdown 文件，您还可以使用 README.hbs或 README.njk带有 readmeasy 的模板并将创建的 API Markdown 包含到您的自定义 README.md 中.

例子

单一命令

下面的命令在临时目录中创建多个文件，将它们合并到 README.md文件并删除临时目录。 ( rimraf 模块用于删除，因为它是跨操作系统兼容的)

$ npm install -D typedoc typedoc-plugin-markdown concat-md rimraf showdown

$ rimraf temp-docs && typedoc --plugin typedoc-plugin-markdown --theme markdown --mode file --out temp-docs && concat-md --toc --decrease-title-levels --dir-name-as-title temp-docs > README.md && showdown makehtml -i README.md -o README.html && rimraf temp-docs

描述

安装必要的模块:

$ npm install -D typedoc typedoc-plugin-markdown concat-md showdown

使用 TypeDoc 注释创建 Markdown 文件到 temp-docs目录:

$ typedoc --plugin typedoc-plugin-markdown --theme markdown --mode file --out temp-docs

创建单个 README.md来自他们的 Markdown 文件:(还创建目录，添加目录名称作为标题，并自动降低标题级别)

$ concat-md --toc --decrease-title-levels --dir-name-as-title temp-docs > README.md

使用任何转换器将创建的 Markdown 转换为 HTML:(我在此示例中使用了 showdown)

$ showdown makehtml -i README.md -o README.html