diff --git a/website/docs/docusaurus-core.mdx b/website/docs/docusaurus-core.mdx index c14a53185e75..696fc4fc31ed 100644 --- a/website/docs/docusaurus-core.mdx +++ b/website/docs/docusaurus-core.mdx @@ -605,6 +605,38 @@ const MyComponent = () => { }; ``` +### `useBrokenLinks` {#useBrokenLinks} + +React hook to access the BrokenLinks context. The context provides methods for collecting and managing information about anchors and links. + +Usage example: + +```js +import useBrokenLinks from '@docusaurus/useBrokenLinks'; + +// MyHeading component +export default function MyHeading({id, ...props}): JSX.Element { + const brokenLinks = useBrokenLinks(); + + brokenLinks.collectAnchor(id); + + return

Heading

; +} +``` + +```js +import useBrokenLinks from '@docusaurus/useBrokenLinks'; + +// MyLink component +export default function MyLink({targetLink, ...props}): JSX.Element { + const brokenLinks = useBrokenLinks(); + + brokenLinks.collectLink(targetLink); + + return Link; +} +``` + ## Functions {#functions} ### `interpolate` {#interpolate-1}