Skip to content
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 inline tags not working in project documents #2629

Closed
yo35 opened this issue Jul 7, 2024 · 2 comments
Closed

@link inline tags not working in project documents #2629

yo35 opened this issue Jul 7, 2024 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@yo35
Copy link

yo35 commented Jul 7, 2024

Search terms

@link, inline, projectDocuments

Expected Behavior

Inline links {@link ...} within markdown documents added with the --projectDocuments option should be resolved, as in the doc comments and as in the readme page.

Actual Behavior

Inline links {@link ...} within markdown documents added with the --projectDocuments option are not resolved : in the generated HTML file, the {@link ...} tag itself is stripped off, but no HTML link is created. No error/warning is reported by TypeDoc in the console.

Steps to reproduce the bug

In file https://github.com/yo35/kokopu/blob/4.11.1/doc_src/tutorials/01_getting_started.md?plain=1,
the tag {@link Position} on line 10 is not resolved: see the generated file.

On the contrary, for the readme Markdown file https://github.com/yo35/kokopu/blob/4.11.1/doc_src/home.md?plain=1, the same tag {@link Positition} on line 43 is properly resolved: see the generated file.

Typedoc config file is https://github.com/yo35/kokopu/blob/4.11.1/typedoc.config.js.

Environment

  • Typedoc version: 0.26.3
  • TypeScript version: 5.5.3
  • Node.js version: 20.15.0
  • OS: Linux Mint
@yo35 yo35 added the bug Functionality does not match expectation label Jul 7, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 10, 2024

I have literally no idea how I didn't notice this was broken before release...

@yo35
Copy link
Author

yo35 commented Jul 13, 2024

Thanks for the fix.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants