From 98e31bb7fcb5a00ec25af50564802da34aa9cec4 Mon Sep 17 00:00:00 2001 From: Warren Parad <5056218+wparad@users.noreply.github.com> Date: Thu, 30 Oct 2025 11:54:23 +0100 Subject: [PATCH] Update documentation on broken link detection Clarify broken link detection behavior and opt-out method. --- website/docs/api/docusaurus.config.js.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx index dc366a39c2..8857a88e56 100644 --- a/website/docs/api/docusaurus.config.js.mdx +++ b/website/docs/api/docusaurus.config.js.mdx @@ -293,6 +293,14 @@ The behavior of Docusaurus when it detects any broken link. 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`. + +To opt out of a broken link, add the HTML attribute `data-noBrokenLinkCheck` to the element that contains the link: + +```jsx +Link +``` + :::note The broken links detection is only available for a production build (`docusaurus build`).