文章/答案/技术大牛

发布

社区首页 >问答首页 >使用TypeDoc链接到外部库文档

问使用TypeDoc链接到外部库文档
EN

Stack Overflow用户

提问于 2019-08-01 03:59:55

回答 1查看 438关注 0票数 4

我有一个TypeScript项目，我正在使用TypeDoc为它生成文档。在我的项目中，我使用了一个拥有自己现有文档的外部库。在我的项目的TypeDoc输出中，我希望将读者链接到外部库的文档，而不必手动插入URL。

我最接近的解决方案是在代码注释中用双括号括起我想要链接的内容，如下所示：

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

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

这有可能实现吗？

javascript

typescript

typedoc

回答 1

Stack Overflow用户

发布于 2020-06-07 18:19:38

是的，您可以使用以下语法:将文本放在方括号中，将[]和url放在括号()之间。

[Text to be displayed](URL)

例如:链接到一个名为pg-structure的npm模块。

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

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

票数 0

页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持

原文链接：

https://stackoverflow.com/questions/57298054

复制

相似问题

问使用TypeDoc链接到外部库文档
EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问使用TypeDoc链接到外部库文档EN

回答 1

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问使用TypeDoc链接到外部库文档
EN