Migrate onBrokenMarkdownLinks to markdown.hooks - #273
Merged
Conversation
Docusaurus v4 deprecates the top-level `siteConfig.onBrokenMarkdownLinks` option. Move it to `siteConfig.markdown.hooks.onBrokenMarkdownLinks` to clear the deprecation warning and stay compatible with v4. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
bdoyal
approved these changes
Jun 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Moves the
onBrokenMarkdownLinks: "warn"setting from the top-levelsiteConfigintositeConfig.markdown.hooks.onBrokenMarkdownLinks.Why
Docusaurus emits this deprecation warning on build:
This change clears the warning and keeps us compatible with Docusaurus v4. Behavior is unchanged — broken markdown links still emit a warning.
Testing
yarn buildcompletes successfully (Node 24.18.0) with noonBrokenMarkdownLinksdeprecation warning.🤖 Generated with Claude Code