TypeDoc generates broken links for `{@linkcode ...}` comments

[mrousavy]

Hey! Thanks for this amazing plugin, I use TypeDoc to generate API documentation for react-native-vision-camera! ❤️

I am using {@linkcode } blocks, (see code here), but for some reason the output links are broken:

Exhaustive list of all broken links found
-> linking to CameraDeviceFormat.md#maxfps (resolved as: /docs/api/interfaces/CameraDeviceFormat.md)

Is there any way to configure that? Or am I using {@linkcode ...} wrong?

[mrousavy]

(The problem is the .md suffix, it needs to be generated without .md, then it's a valid link)

[mrousavy]

The issue occurs only when there's many {@linkcode ...} statements close by, weirdly if I add text inbetween those links it compiles fine...

[tgreyuk]

So I have done a bit of digging and {@linkcode} is parsing correctly but there does seem to be a Docusaurus bug in resolving broken links when a link is immediately followed by a parenthesis.

broken: [label](page.md#anchorName) (see [label](page.md#anchorName))

ok: see ([label](page.md#anchorName))

ok: [label](page.md#anchorName) - (see [label](page.md#anchorName))

[mrousavy]

Interesting! Thanks for your insights, I guess this should be reported in the Docusaurus repo then?

[tgreyuk]

I guess this should be reported in the Docusaurus repo then?

Yes I think so - I'll do a bit more investigation and raise a ticket.

[mrousavy]

Awesome, thank you I appreciate it! 🙏

[bo-carey]

@tgreyuk - I am also experiencing this bug. Have you made a ticket?

[tgreyuk]

Thanks @bo-carey i was just looking at this and i notice you have already raised a ticket. I am linking to it here as a reference - https://github.com/facebook/docusaurus/issues/9518 .

[bo-carey]

@tgreyuk thanks for that, Tom!

[tgreyuk]

Have tested and I can confirm that this issue has been fixed in Docusaurus 3.4. https://github.com/facebook/docusaurus/pull/10168.