diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx index dc366a39c2a5..87a4ee8171a2 100644 --- a/website/docs/api/docusaurus.config.js.mdx +++ b/website/docs/api/docusaurus.config.js.mdx @@ -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 `` 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 +``` + :::note The broken links detection is only available for a production build (`docusaurus build`).