Linking to external library documentation with TypeDoc

对着背影说爱祢 提交于 2019-12-12 11:22:24

问题


I have a TypeScript project, and I'm using TypeDoc to generate documentation for it. In my project I am using an external library that has its own existing documentation. In the TypeDoc output for my project I want to link the reader to the documentation for the external library without having to manually insert a URL.

The closest I've come to a solution is placing double brackets in the code comments around what I want to link to, like this:

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

But this doesn't seem to work for types in an external library.

Is this possible to achieve?

来源:https://stackoverflow.com/questions/57298054/linking-to-external-library-documentation-with-typedoc

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!