You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a major upgrade from Docusaurus v2 to v3 which includes significant breaking changes. The upgrade requires mandatory code and environment modifications.
Key Breaking Changes:
MDX v1 → v3 Upgrade: This is the most impactful change. MDX v3 enforces stricter parsing of Markdown and JSX. Content that compiled successfully in v2 may now fail to build or render differently. You will need to review and likely update .md and .mdx files, particularly those with { or < characters or JSX syntax.
Node.js Requirement: Support for Node.js versions below 18.0 has been dropped. You must be on Node.js v18.0 or newer.
React 17 → 18 Upgrade: Docusaurus now requires React 18. This may introduce subtle behavioral changes, such as new hydration errors in the console and differences in state update batching. Custom React components should be reviewed.
TypeScript Requirement: Requires TypeScript v5.1 or newer.
Other Notable Changes:
The ::caution admonition is deprecated in favor of ::warning.
The default RSS feed limit for blogs is now 20 entries.
Recommendation:
This upgrade requires careful planning. Before upgrading, it is highly recommended to:
Use the npx docusaurus-mdx-checker command on your v2 project to identify content files that will require modification for MDX v3 compatibility.
Ensure your development and deployment environments are updated to Node.js v18+.
Notice 🤖: This content was augmented using artificial intelligence. AI-generated content may contain errors and should be reviewed for accuracy before use.
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
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.
Snyk has created this PR to fix 1 vulnerabilities in the npm dependencies of this project.
Snyk changed the following file(s):
site2/website-next/package.jsonVulnerabilities that will be fixed with an upgrade:
SNYK-JS-REACTDEVUTILS-17890708
Breaking Change Risk
Important
Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open fix PRs.
For more information:
🧐 View latest project report
📜 Customise PR templates
🛠 Adjust project settings
📚 Read about Snyk's upgrade logic
Learn how to fix vulnerabilities with free interactive lessons:
🦉 Command Injection