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

Invalid references in @link are ignored #30

Open
B4nan opened this issue Mar 11, 2022 · 3 comments
Open

Invalid references in @link are ignored #30

B4nan opened this issue Mar 11, 2022 · 3 comments

Comments

@B4nan
Copy link
Contributor

B4nan commented Mar 11, 2022

Currently if the reference is not valid, it will be silently rendered as a regular text. Would be great to respect the docusaurus link validation hooks - onBrokenLinks and onBrokenMarkdownLinks. Maybe you could leverage the @docusaurus/Link component that handles this automatically (we extend this ourselves to do the versioned links to API docs from outside of it).

@milesj
Copy link
Owner

milesj commented Mar 11, 2022

We'd have to change this to Link and hopefully it doesn't break anything. https://github.com/milesj/docusaurus-plugin-typedoc-api/blob/master/packages/plugin/src/components/Markdown.tsx#L71

@milesj
Copy link
Owner

milesj commented Mar 29, 2022

Hrmm, so it looks like this is already using Link. Not sure what to do next.

@milesj
Copy link
Owner

milesj commented Mar 29, 2022

Actually, the problem is that these docblocks are rendered at runtime within the browser, and are not part of the Docusaurus build at all. This is definitely a blocker at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants