是否可以为TypeScript项目生成带有TypeDoc的单页文档html？

假设我的库中有两个名为

SuperBase

的TypeScript类。

数据库

和

记录

TypeDoc是否有可能生成一个具有以下非常简单格式的页面。它不一定是那样的，只是一些简单和相似的东西

它应该是非常简单和最小的，并且只有一页。就像你会在降价自述中写自己一样。它所需要做的只是从源代码中获取这些文档并将其粘贴到单个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

可以在单个命令中使用、和。结果，你们都有一个单独的页面标记和HTML在一起

（免责声明：我是开源软件的开发者）

怎么 从TypeDoc注释生成一系列标记文件，并从多个标记文件创建单个文件

如果您需要进一步自定义

README.md

文件，除了包含已创建的API标记文件外，还可以使用

README.hbs

或

README.njk

模板，并将已创建的API标记包含到自定义的

README.md

中

例子 单一命令 下面的命令将多个文件创建到临时目录中，将它们合并到

README.md

文件并删除临时目录。（模块用于删除，因为它是跨操作系统兼容的）

描述

• 安装必要的模块：

• 使用TypeDoc注释在

  temp docs

  目录中创建标记文件：

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

• 从它们创建一个单独的

  README.md

  标记文件：（还创建目录，添加目录名作为标题，并自动降低标题级别）

$concat md--toc--降低标题级别--目录名为title temp docs>README.md

• 使用任意转换器将创建的标记转换为HTML：（我在本例中使用了决战）

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

$ 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