generated from okp4/template-oss
-
Notifications
You must be signed in to change notification settings - Fork 24
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
During the build process with Docusaurus v3.9.1, the following warning is emitted:
Warning: The
siteConfig.onBrokenMarkdownLinksconfig option is deprecated and will be removed in a future Docusaurus version.
Please migrate and move this option tositeConfig.markdown.hooks.onBrokenMarkdownLinksinstead.
See the GitHub Actions log for details: https://github.com/axone-protocol/docs/actions/runs/18105930114/job/51520333696
Current Configuration
The deprecated option is set in docusaurus.config.js:
// https://github.com/axone-protocol/docs/blob/main/docusaurus.config.js
onBrokenMarkdownLinks: 'throw',Proposed Solution
- Migrate the
onBrokenMarkdownLinksconfig from the root level tositeConfig.markdown.hooks.onBrokenMarkdownLinksas suggested by the warning message. - Test the build to confirm the warning is resolved.
References
Related code
docusaurus.config.js
// @ts-check
/** @type {import('@docusaurus/types').Config} */
const config = {
...
onBrokenMarkdownLinks: 'throw',
...
markdown: {
mermaid: true
// Move hooks config here as per Docusaurus config requirements
},
...
};Copilot
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Type
Projects
Status
β
Done