{@link target} syntax doesn't work within included markdown files

[personalizedrefrigerator]

Search terms

[[include:]], include, markdown, included markdown, .md, links, @link.

Expected Behavior

Links to symbols created with {@link symbolName} should be rendered in included markdown files.

Actual Behavior

{@link ...}s are rendered without formatting. For example,

Steps to reproduce the bug

Sample repository.

Steps:

1. Create a markdown file in a project's markdown include directory
2. Include the markdown file in the README or a documentation comment with [[include:markdown-file-name-here.md]].
3. Link to a symbol using the {@link symbolName} in the included markdown file.
4. Link to the same symbol in a documentation comment

Environment

• Typedoc version: 0.25.2
• TypeScript version: 5.2.2
• Node.js version: v18.13.0
• OS: Ubuntu 23.10

[Gerrit0]

Because of when include resolution happens, it isn't possible for links to be resolved. Include resolution would have to happen during conversion rather than during rendering for this to work.

I'm not entirely sure why include resolution was done there, that option was added before I started maintaining typedoc... it seems to me like it ought to happen during Converter.EVENT_RESOLVE, which would allow links to work. It also seems like this ought to take into account the source location of the file rather than using a hardcoded include directory... (maybe allowing the configuration of a baseUrl for non-relative imports like how node does...)

Changing any of this is breaking and would have to wait for 0.26, but an {@include ./file.md} could be implemented without a breaking change...

[dpthinh910]

Because of when include resolution happens, it isn't possible for links to be resolved. Include resolution would have to happen during conversion rather than during rendering for this to work.

I'm not entirely sure why include resolution was done there, that option was added before I started maintaining typedoc... it seems to me like it ought to happen during Converter.EVENT_RESOLVE, which would allow links to work. It also seems like this ought to take into account the source location of the file rather than using a hardcoded include directory... (maybe allowing the configuration of a baseUrl for non-relative imports like how node does...)

Changing any of this is breaking and would have to wait for 0.26, but an {@include ./file.md} could be implemented without a breaking change...

Hi @Gerrit0 , do you have any ETA for this feature? I have just upgraded my project to typedoc@0.25.4 and typescript@5 and there's no way I can use the @link tag inside the included markdown content

[Gerrit0]

No, I avoid ETAs as they're a great way to disappoint people. The include option has also always felt like a bad hack to me as the content of those markdown files will not appear in VSCode.

[Dayday10]

Thanks for sharing that.

…

On Tue, Dec 26, 2023, 8:03 PM Gerrit Birkeland ***@***.***> wrote: No, I avoid ETAs as they're a great way to disappoint people. The include option has also always felt like a bad hack to me as the content of those markdown files will not appear in VSCode. — Reply to this email directly, view it on GitHub <#2419 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AWMIKFP7LM26LEEZZTIA7BTYLN6VTAVCNFSM6AAAAAA6NBFVZKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQNRZHA3TOMRTHE> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[dpthinh910]

Thanks for sharing your opinion, a/w do you have any idea to achieve this feat? Before this upgrade i was using 0.17 and everything works fine with the monorepo-links plugin @Gerrit0

[Dayday10]

Most creditable,needs tightened up ,take time to make it right.

[Gerrit0]

In 0.26, the --includes option has been replaced with a @document tag to add additional markdown pages to the generated site, and @link works there,