Open nberlette opened 3 months ago
We have a patch that already landed (#580) that fixes the high-level issue that its rendered double. however linking itself is a separate issue thats trickier, and has a todo: https://github.com/denoland/deno_doc/blob/b238c88caac7200646262b8f07117c6601a5dff6/src/html/pages.rs#L175
Deno Version
Expected Behavior
The
@linkcode
and@link
tags in symbol descriptions should generate a link with and without a<code>
tag around the specified text, respectively.This provides clear and navigable links within the documentation. Since the individual symbol pages handle these JSDoc tags as expected, I would also expect for the "all symbols" page to do the same.
Actual Behavior
The
@link
and@linkcode
tags are not handled correctly on the "all symbols" pages, and end up rendered without any hyperlink at all, and two instances of the linked symbol name.For example,
{@link TrimLeft}
renders asTrimLeft | TrimLeft
, and{@linkcode TrimLeft}
renders as<code>TrimLeft</code> | TrimLeft
(with no links in either).All Symbols
Individual Symbol
Documented Code
This is the code that the documentation was generated from in the above screenshots:
Thanks for your time.