使用TypeDoc链接到外部库文档

问题描述 投票:4回答:1

我有一个TypeScript项目,并且我正在使用TypeDoc为其生成文档。在我的项目中,我使用的是具有自己现有文档的外部库。在我的项目的TypeDoc输出中,我希望将阅读器链接到外部库的文档,而无需手动插入URL。

最接近解决方案的地方是在代码注释中将双括号放在要链接的内容周围,如下所示:

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

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

这有可能实现吗?

javascript typescript typedoc
1个回答
0
投票

是的,您可以使用以下语法,方法是在方括号[]之间放置文本,在括号()之间放置URL。

[Text to be displayed](URL)

例如:链接到名为npmpg-structure模块。

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

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

enter image description here

© www.soinside.com 2019 - 2024. All rights reserved.