Linking To External Library Documentation With Typedoc
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 Ty
Solution 1:
Yes you can use following syntax by putting text between square brackets []
and url between parenthesis ()
.
[Text to be displayed](URL)
For example: Link to an npm
module called pg-structure
.
[pg-structure](https://www.npmjs.com/package/pg-structure)
I also usually link to related paragraph by copying from npm
link icon left to title. (See icon left to Synopsis
title in example picture below)
Post a Comment for "Linking To External Library Documentation With Typedoc"