首页 > 解决方案 > 使用 TypeDoc 链接到外部库文档

问题描述

我有一个 TypeScript 项目,我正在使用 TypeDoc 为其生成文档。在我的项目中,我使用了一个拥有自己现有文档的外部库。在我的项目的 TypeDoc 输出中,我想将读者链接到外部库的文档,而无需手动插入 URL。

我最接近解决方案的方法是在我想要链接的代码注释中放置双括号,如下所示:

/** I want to link to something called [[Foo]] */

但这似乎不适用于外部库中的类型。

这有可能实现吗?

标签: javascripttypescripttypedoc

解决方案


[]是的,您可以通过将文本放在方括号之间并将 url放在括号之间来使用以下语法()

[Text to be displayed](URL)

例如:链接到一个npm名为pg-structure.

[pg-structure](https://www.npmjs.com/package/pg-structure)

npm我通常也通过从链接图标左侧复制到标题来链接到相关段落。Synopsis(请参见下面示例图片中标题左侧的图标)

在此处输入图像描述


推荐阅读