-
Notifications
You must be signed in to change notification settings - Fork 180
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
hyperlink not generated for {@link type#property}
#732
Comments
Thanks - links on props are now resolved in |
Thanks for the quick fix @tgreyuk and appreciate the clarification on usage of Types are looking good with this fix but there is a strange issue with interfaces. Repro: https://stackblitz.com/edit/vitejs-vite-zdmljw8o When using |
You are absolutely correct, this isn't quite correct. The idea is that when an anchor cannot be resolved it fallsback to the nearest available anchor, but like you say the interface anchors should not be effected by the options you have set. Also foo.md#__type is not a correct fallback. Thanks again - ill be fixed in next patch. |
What package is the bug related to?
typedoc-plugin-markdown
Describe the issue
When using
@link
to reference a type property, the generated markdown is not hyperlinked.Repro: https://stackblitz.com/edit/vitejs-vite-rq6ycbce
Steps to Reproduce
npm run docs:md
docs-md/functions/handleFoo.md
Actual Result
Generated markdown does not hyperlink the
name
property:Additional Information
Foo
itself does get hyperlinkeduseHTMLAnchors=true
but this did not result inname
being hyperlinked either. In fact, there didn't seem to be any anchor elements generated at all - possibly I'm misunderstandinguseHTMLAnchors
or this may be a separate bug/issue?TypeDoc configuration
typedoc: 0.27.3
typedoc-plugin-markdown: 4.3.1
typescript: 5.7.2
Expected behavior
The property
name
should be hyperlinked.The text was updated successfully, but these errors were encountered: