Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

## 3.0.0-beta.0 (2023-09-15) #10635

Closed
GIgako19929 opened this issue Oct 31, 2024 · 0 comments
Closed

## 3.0.0-beta.0 (2023-09-15) #10635

GIgako19929 opened this issue Oct 31, 2024 · 0 comments

Comments

@GIgako19929
Copy link

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:

  • MDX 2
  • React 18
  • TS 5
  • Mermaid 10

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
    • #9310 chore(plugin-docs): remove legacy versioned prefix on doc ids and sidebar names in versioned sidebars (@slorber)
  • docusaurus-theme-classic, docusaurus-theme-translations
    • #9308 fix(theme): make warning a first-class admonition, and deprecate caution admonition (@slorber)
  • docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-mermaid
    • #9305 feat(theme-mermaid): upgrade Mermaid to v10.4 - handle async rendering (@slorber)
  • 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
    • #9258 feat: Docusaurus v3 upgrades and require TypeScript 5 (@slorber)
  • docusaurus-plugin-content-blog
  • create-docusaurus, docusaurus-tsconfig
    • #9050 feat: create official TypeScript base config @docusaurus/tsconfig (@slorber)
  • 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
    • #8961 feat: React 18 + automatic JSX runtime + build --dev (@slorber)
  • 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
    • #7966 fix(plugin-docs,theme): refactor docs plugin routes and component tree (@slorber)

This discussion was created from the release 3.0.0-beta.0.

Originally posted by @slorber in #9312

@Josh-Cena Josh-Cena closed this as not planned Won't fix, can't repro, duplicate, stale Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants