Skip to content

Update documentation on broken link detection #11520 #11521

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.

Sign up for GitHub

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

Closed
wparad wants to merge 2 commits into from
Closed

Update documentation on broken link detection #11520 #11521

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98e31bb
Update documentation on broken link detection
wparad Oct 30, 2025
13ac115
Update docusaurus.config.js.mdx
wparad Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion website/docs/api/docusaurus.config.js.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,10 +289,18 @@ export default {

- Type: `'ignore' | 'log' | 'warn' | 'throw'`

The behavior of Docusaurus when it detects any broken link.
The behavior of Docusaurus when it detects any broken link `to` found in the Docusaurus `<Link>` element.

By default, it throws an error, to ensure you never ship any broken link.

Broken link detection only applies to relative internal links that the Docusaurus framework knows about.

To opt out of a broken link, add the attribute `data-noBrokenLinkCheck` to the `Link` element that contains the broken link:

```jsx
<Link to="/broken-link" data-noBrokenLinkCheck>Link</Link>
```

:::note

The broken links detection is only available for a production build (`docusaurus build`).
Expand Down