Skip to content

Fix deprecated siteConfig.onBrokenMarkdownLinks config before Docusaurus v4 #22

@dfberry

Description

@dfberry

Problem

docusaurus.config.js uses the deprecated onBrokenMarkdownLinks option at the top-level siteConfig object. This will be removed in Docusaurus v4.

Build warning:

[WARNING] The `siteConfig.onBrokenMarkdownLinks` config option is deprecated and will be removed in Docusaurus v4.
Please migrate and move this option to `siteConfig.markdown.hooks.onBrokenMarkdownLinks` instead.

Fix

In website/docusaurus.config.js, move the option from the top-level config to the markdown.hooks object:

// Before (deprecated)
onBrokenMarkdownLinks: 'warn',

// After
markdown: {
  hooks: {
    onBrokenMarkdownLinks: 'warn',
  },
},

File

website/docusaurus.config.js

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingsquadSquad team work queuesquad:kayleeAssigned to Kaylee (Full-Stack TS Dev)

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions