Skip to content

Prepare Docs for upcoming Docusaurus v4.0's breaking changes. #291

@BluWizard10

Description

@BluWizard10

Docusaurus v4.0 is going to be releasing sometime in the near future, which will introduce a lot of breaking changes that must be resolved as soon as possible for the Creators Docs to be future-proofed.

Here's what's going on:

  • Docusaurus Faster is now recommended. Docusaurus Faster facebook/docusaurus#10556
  • Admonition Titles must be migrated from :::note Title to the directive form :::note[Title] since mdx1CompatDisabledByDefault disables the legacy parser.
  • Rename all .md files to .mdx to align with v4 conventions, as v4 will fully enforce MDX v3.
  • Any HTML comments must be converted to use JSX comment syntax.
  • Link references to .md files must be updated to renamed .mdx files.

Full details from Docusaurus v3.10 release for further reading: https://docusaurus.io/blog/releases/3.10

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions