New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Link text doesn't become a link when using {@link X | Y} #1302
Comments
I can't seem to get I looked through your repo and noticed that you have a few regular |
Oh sorry I gave a hypothetical example. Foo isn't a class or type or anything so it shouldn't work anyway? In my repo, an example of a working {@link} tag is |
Fixed with 935e10a, should hopefully have a release later today, or at least by the end of the weekend. |
@mjackson I just created https://typedoc.org/guides/link-resolution/, which should hopefully answer your question. If it doesn't, feel free to create a new issue |
That's actually pretty clear! However, I did notice that in the commit |
I think the doc page linked above covers that, did I miss something? |
Maybe i missed it but i can’t find documentation about using the “” quotes to specify a file path directly to where we want to have typedoc search for symbols first |
Looks like you're right, I thought I mentioned it. Adding this under the structure block:
|
v0.17.7 released with this :) |
Search terms
link, link text
Expected Behavior
Something such as
{@link MyClass | some other text}
should show up as a link to MyClass but the text is "some other text"Actual Behavior
Instead, the documentation just shows "{@link MyClass | some other text}" literally, not parsed.
Steps to reproduce the bug
The repo I'm working on https://github.com/stonet2000/dimensions
Just adding
{@link MyClass | some other text}
over a class and running the following command:My typedoc.json:
(I realize that I don't need all of those command line args)
My tsconfig.json
Environment
The text was updated successfully, but these errors were encountered: