Skip to content

@link inline tags not working in project documents #2629

Closed
@yo35

Description

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

Metadata

Assignees

No one assigned

    Labels

    bugFunctionality does not match expectation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions