使用 TypeDoc 鏈接到外部庫文檔

Question

我有一個 TypeScript 項目，我正在使用 TypeDoc 為其生成文檔。 在我的項目中，我使用了一個擁有自己現有文檔的外部庫。 在我的項目的 TypeDoc 輸出中，我想將閱讀器鏈接到外部庫的文檔，而無需手動插入 URL。

我最接近解決方案的是在代碼注釋中圍繞我想要鏈接的內容放置雙括號，如下所示：

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

但這似乎不適用於外部庫中的類型。

這有可能實現嗎？

Answer 1

是的，您可以通過將文本放在方括號[]和括號()之間的 url 之間來使用以下語法。

[Text to be displayed](URL)

例如：鏈接到名為pg-structure的npm模塊。

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

我通常也通過從npm鏈接圖標左復制到標題來鏈接到相關段落。 （請參閱下面示例圖片中Synopsis標題左側的圖標）