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
MDX v2 is the most annoying breaking change of Docusaurus v3: it will likely require you to update a few md/mdx files to ensure they still compile fine. Read the dedicated MDX v2 PR for more details.
Notably, characters such as { and < will likely raise new MDX compilation errors. The MDX v2 playground is your new best friend to troubleshoot these issues.
A cli will be introduced soon. It should provide a convenient way to detect which of your docs will fail to compile under MDX v2. You can run npx docusaurus-mdx-checker to have a preview.
3.0.0-beta.0 (2023-09-15)
Docusaurus v3 is now used by at least 3 major sites: Docusaurus, Jest and React-Native.
We fixed all the tiny issues encountered during that process.
This is now time to move v3 to the beta stage!
Main changes
Docusaurus v3 is mostly an infrastructure upgrade, notably:
There are other "functional" breaking changes that should be relatively easy to handle.
The UI should mostly remain unchanged from the latest v2.x release.
New features coming with v3 will be presented later during the final release.
Example upgrade PRs:
Use these PRs as inspiration to figure out what it takes to upgrade to v3:
Release links
Breaking changes
MDX v2 is the most annoying breaking change of Docusaurus v3: it will likely require you to update a few md/mdx files to ensure they still compile fine. Read the dedicated MDX v2 PR for more details.
Notably, characters such as
{
and<
will likely raise new MDX compilation errors. The MDX v2 playground is your new best friend to troubleshoot these issues.We also created a dedicated support discussion: MDX v2 - Upgrade Support
A cli will be introduced soon. It should provide a convenient way to detect which of your docs will fail to compile under MDX v2. You can run
npx docusaurus-mdx-checker
to have a preview.💥 Breaking Change
docusaurus-plugin-content-docs
,docusaurus-theme-classic
docusaurus-theme-classic
,docusaurus-theme-translations
docusaurus-theme-common
,docusaurus-theme-live-codeblock
,docusaurus-theme-mermaid
create-docusaurus
,docusaurus-plugin-content-docs
,docusaurus-plugin-debug
,docusaurus-plugin-google-analytics
,docusaurus-plugin-google-gtag
,docusaurus-plugin-google-tag-manager
,docusaurus-plugin-ideal-image
,docusaurus-plugin-pwa
,docusaurus-theme-classic
,docusaurus-theme-common
,docusaurus-theme-live-codeblock
,docusaurus-theme-mermaid
,docusaurus-theme-search-algolia
,docusaurus-tsconfig
,docusaurus
docusaurus-plugin-content-blog
create-docusaurus
,docusaurus-tsconfig
create-docusaurus
,docusaurus-mdx-loader
,docusaurus-module-type-aliases
,docusaurus-plugin-client-redirects
,docusaurus-plugin-content-blog
,docusaurus-plugin-content-docs
,docusaurus-plugin-content-pages
,docusaurus-plugin-debug
,docusaurus-plugin-google-analytics
,docusaurus-plugin-google-gtag
,docusaurus-plugin-google-tag-manager
,docusaurus-plugin-ideal-image
,docusaurus-plugin-pwa
,docusaurus-plugin-sitemap
,docusaurus-preset-classic
,docusaurus-theme-classic
,docusaurus-theme-common
,docusaurus-theme-live-codeblock
,docusaurus-theme-mermaid
,docusaurus-theme-search-algolia
,docusaurus-types
,docusaurus
create-docusaurus
create-docusaurus
,docusaurus-mdx-loader
,docusaurus-migrate
,docusaurus-plugin-content-blog
,docusaurus-remark-plugin-npm2yarn
,docusaurus-theme-classic
,docusaurus-theme-common
,docusaurus-theme-mermaid
,docusaurus-types
,docusaurus-utils-validation
,docusaurus-utils
,docusaurus
docusaurus-plugin-content-docs
,docusaurus-theme-classic
,docusaurus-theme-common
,docusaurus
This discussion was created from the release 3.0.0-beta.0.
Originally posted by @slorber in #9312
The text was updated successfully, but these errors were encountered: