Update documentation on broken link detection #11520 #11521
+9
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarify broken link detection behavior and opt-out method.
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
slorber
requested changes
Oct 30, 2025
|
|
||
| By default, it throws an error, to ensure you never ship any broken link. | ||
|
|
||
| Broken link detection only applies to relative links within a plugin, it does not work across plugins nor on pages specified in `/pages` or `static`. |
There was a problem hiding this comment.
That's not really accurate. It's unclear to me what it means to "not work across plugins", and it definitively works if you link to /my-page after creating a pages/my-page.md file
|
|
||
| Broken link detection only applies to relative links within a plugin, it does not work across plugins nor on pages specified in `/pages` or `static`. | ||
|
|
||
| To opt out of a broken link, add the HTML attribute `data-noBrokenLinkCheck` to the element that contains the link: |
There was a problem hiding this comment.
this is not an HTML attribute (although it's technically legal to pass any data attribute to HTML elements), it is a proprietary React component prop of the Docusaurus <Link> component
As explained here, we don't document it on purpose, and only share this secret API after having clearly understood why a user need it
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Clarify broken link detection behavior and opt-out method.