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 1/2] 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 dc366a39c2a5..8857a88e5681 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`). From 13ac1156cbc2a2a739c87d6005a9a09687b3f955 Mon Sep 17 00:00:00 2001 From: Warren Parad <5056218+wparad@users.noreply.github.com> Date: Thu, 30 Oct 2025 12:26:41 +0100 Subject: [PATCH 2/2] Update docusaurus.config.js.mdx --- website/docs/api/docusaurus.config.js.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx index 8857a88e5681..87a4ee8171a2 100644 --- a/website/docs/api/docusaurus.config.js.mdx +++ b/website/docs/api/docusaurus.config.js.mdx @@ -289,13 +289,13 @@ 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 `` element. 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`. +Broken link detection only applies to relative internal links that the Docusaurus framework knows about. -To opt out of a broken link, add the HTML attribute `data-noBrokenLinkCheck` to the element that contains the link: +To opt out of a broken link, add the attribute `data-noBrokenLinkCheck` to the `Link` element that contains the broken link: ```jsx Link