Skip to content

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Oct 26, 2023

Motivation

Release Docusaurus v3.0.0-rc.1

Same as rc.0, but with MDX v3 instead of v2.

Links:


v3.0.0-rc.1 (2023-10-26)

💥 Breaking Change

  • create-docusaurus, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic
  • create-docusaurus, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus-utils, docusaurus
    • #9317 feat(core): support TypeScript + ESM configuration (@harryzcy)
  • create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus
    • #9316 chore: upgrade syntax highlighting dependencies, prism-react-renderer to v2, react-live to v4 (@harryzcy)
  • create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, 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-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-mermaid, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, eslint-plugin, lqip-loader
  • 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)

🚀 New Feature

  • create-docusaurus, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic
  • docusaurus-mdx-loader, docusaurus-utils
    • #9394 feat(mdx-loader): Remark plugin to report unused MDX / Markdown directives (@OzakIOne)
  • create-docusaurus, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus-utils, docusaurus
    • #9317 feat(core): support TypeScript + ESM configuration (@harryzcy)
  • 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-blog
  • docusaurus-theme-classic
    • #9152 feat(theme): add support for meta og locale and alternates (@FlorinaPacurar)
    • #9028 feat(theme): add ability to inject data attributes from query-string - possibility to create an iframe/embed variant of a page (@slorber)
    • #8915 feat(theme): add queryString option to localeDropdown (@wceolin)
  • docusaurus-plugin-client-redirects, docusaurus-utils-validation
    • #9171 feat(client-redirects-plugin): support fully qualified urls and querystring/hash in destination/to url (@slorber)
  • docusaurus
  • docusaurus-mdx-loader, docusaurus-types, docusaurus
    • #9097 feat(mdx): add siteConfig.markdown.format to configure the default content parser (MDX / CommonMark) (@slorber)
  • docusaurus-plugin-content-pages, docusaurus-theme-classic
    • #9071 feat(pages): add support for missing SEO front matter + improve SEO docs (@slorber)
  • 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)
  • docusaurus-theme-common
    • #8982 feat(theme-common): code block MagicComments support for TeX/LaTeX/Matlab (@jj-style)
    • #8870 feat(theme-common): code block MagicComments support for Lua/Haskell -- and WebAssembly ;; (@tarunrajput)
  • 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-theme-classic, docusaurus-theme-common
    • #8890 feat(theme): create more generic ThemedComponent util from ThemedImage (@slorber)
  • create-docusaurus, docusaurus-theme-classic, docusaurus-theme-search-algolia, eslint-plugin
  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus, eslint-plugin
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils
    • #8004 feat(docs,blog,pages): add support for "unlisted" front matter - hide md content in production (@jodyheavener)

🐛 Bug Fix

  • docusaurus
    • #9387 fix(core): log missing errorInfo in React 18 onRecoverableError callback (@johnnyreilly)
    • #9309 fix(cli): disable vertical borders of the update notification (@qwerzl)
    • #9112 fix(core): throw error if build folder already exists on initial clean (@thedevwonder)
    • #9006 fix(core): docusaurus CLI should detect the correct yarn version when suggesting upgrades (@0420syj)
    • #7951 fix(core): make webpack HMR always listen to current location (@jeengbe)
  • docusaurus-mdx-loader
    • #9386 fix(mdx-loader): get correct error line numbers, handle front matter + contentTitle with remark (@slorber)
    • #9262 fix(mdx-loader): improve mdxJsxTextElementToHtml (@slorber)
    • #9202 fix(mdx-loader): ensure heading anchor slugs respect GitHub emoji behavior (@yosukekato165)
    • #9100 fix(mdx): fix for html multi-line comments (@slorber)
    • #9091 fix(mdx-loader): loader error message should display stacktrace if no extra MDX details (@slorber)
    • #8960 fix: allow html syntax in MDX v2 with format md (@slorber)
  • docusaurus-theme-classic
    • #9385 fix(theme): avoid rendering empty search container if site has no search plugin (@slorber)
    • #9183 fix(theme): make Prism code block language / additionalLanguages case insensitive (@heysujal)
    • #9216 fix(theme): fix typo in swizzle component config (@sixhobbits)
    • #9093 fix(theme): support details/summary in CommonMark + add md dogfood test cases (@slorber)
  • docusaurus-mdx-loader, docusaurus-utils
    • #9369 fix(mdx-loader): prevent Open Graph images from being inserted as base64 (@Zwyx)
  • docusaurus-theme-translations
    • #9362 fix(theme-translations): add Japanese translation for "warning" (@tats-u)
    • #9321 fix(theme-translations): add missing zh-Hans messages (@chudongvip)
    • #9338 fix(theme-translations): complete and fix hungarian translations (@la55u)
    • #9292 fix(theme-translations): add missing Spanish theme translations (@Villanuevand)
    • #9021 fix(theme-transalations): fix Swedish translation of "last updated" (@gazab)
  • docusaurus-theme-classic, docusaurus-theme-translations
    • #9308 fix(theme): make warning a first-class admonition, and deprecate caution admonition (@slorber)
    • #9269 fix(theme): improve docs sidebar category caret aria-label accessibility (@pinakipb2)
  • Other
  • docusaurus-theme-common
    • #9446 fix(theme): fix useWindowSize React hydration issue (@slorber)
    • #9276 fix(theme-common): remove useless useSyncExternalStore shim (@slorber)
  • create-docusaurus
    • #9217 fix(create-docusaurus): increase Browserslist support query in dev (@slorber)
  • docusaurus-plugin-content-blog
    • #9437 fix(plugin-blog): blog archive should hide unlisted blog posts (@slorber)
    • #9151 fix(content-blog): links in feed should be absolute (@VinceCYLiao)
  • docusaurus-utils, docusaurus
  • docusaurus-plugin-debug
    • #9116 fix(debug-plugin): upgrade react-json-view to maintained React-18 compatible fork (@slorber)
  • docusaurus-utils
    • #9046 fix(utils): better handling of code blocks in link replacement (@Josh-Cena)
    • #8927 fix(utils): make Markdown link replacement much more rigorous (@Josh-Cena)
    • #7864 fix(utils): always match exclusion root dirs as complete folder paths (@Josh-Cena)
    • #7801 fix(utils): recognize ~~~ as code fences in link replacement (@Josh-Cena)
  • docusaurus-plugin-pwa, docusaurus
    • #8872 fix(core): better error logging on SSR/dev failures + log stacktraces and error causes (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils-validation, docusaurus
    • #8258 fix(docusaurus-utils-validation): baseUrl + routeBasePath: allow empty string, normalized as "/" (@Djunnni)
  • docusaurus-theme-classic, docusaurus-theme-common
    • #8319 fix(docs,theme): auto-generated category index should not display unlisted content (@slorber)
  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock
    • #8015 fix(live-codeblock): add error boundary to live code preview (@rashidmya)
  • docusaurus-mdx-loader, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-validation, docusaurus
    • #7945 refactor(theme): split admonitions, make swizzle easier, better retrocompatibility (@slorber)
  • docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus
    • #7966 fix(plugin-docs,theme): refactor docs plugin routes and component tree (@slorber)

🏃‍♀️ Performance

  • docusaurus
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus
    • #8972 fix: remove useless js-loader in front of mdx-loader (@slorber)

💅 Polish

  • docusaurus
    • #9381 feat(core): throw error when official docusaurus dependencies use different versions (@JorensM)
  • docusaurus-theme-translations
    • #9302 chore(theme-translations): complete zh-Hant translations (@qwerzl)
    • #9025 chore(theme-translations): complete it translations (@bitpredator)
  • docusaurus-theme-classic
    • #9438 refactor(blog-plugin): blog archive reverse ordering of posts (@slorber)
    • #9184 fix(theme): change schema.org itemType prop urls from http to https (@thedevwonder)
  • create-docusaurus, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus
    • #9133 fix(init): change initial site URL to one that is safe for the future (@tats-u)
  • docusaurus-theme-classic, docusaurus-theme-common
    • #8150 fix(theme-classic): polish admonition details, render title-only admonitions (@attitude)
  • docusaurus-plugin-google-gtag
    • #8143 refactor(plugin-gtag): update gtag plugin to modern SPA recommendations (@lanegoolsby)
  • docusaurus-mdx-loader, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-validation, docusaurus
    • #7945 refactor(theme): split admonitions, make swizzle easier, better retrocompatibility (@slorber)

📝 Documentation

🤖 Dependencies

  • Other
  • create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, 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-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-mermaid, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, eslint-plugin, lqip-loader, stylelint-copyright
  • create-docusaurus
  • create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils, docusaurus
  • create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus-utils, docusaurus, eslint-plugin, lqip-loader, stylelint-copyright
  • create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus, eslint-plugin
  • create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-pwa, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, eslint-plugin
  • create-docusaurus, docusaurus-mdx-loader, docusaurus-plugin-pwa, docusaurus, eslint-plugin

🔧 Maintenance

  • docusaurus-migrate
  • docusaurus-theme-search-algolia
    • #9320 chore(theme-search-algolia): revert docsearch package range downgrade after bugfix release (@slorber)
  • docusaurus-theme-translations
    • #9304 chore(theme-translations): complete French translations (@forresst)
  • Other
    • #9264 ci: only install Chromium for Playwright Argos tests (@mxschmitt)
    • #9245 chore: bump devcontainer to Ubuntu 22.04 to resolve arm64 incompatibility (@AFRUITPIE)
    • #8947 test: add visual regression tests with Argos CI (@slorber)
    • #8911 chore: migrate website config to createConfigAsync (@slorber)
    • #8578 docs: fix dead anchor for issue reporting guidelines in template (@Sainan)
    • #8447 chore: update lerna to v6.2.0 (@AgentEnder)
    • #7967 test: improve e2e verdaccio configuration (@juanpicado)
    • #7863 docs: publish 2.0.0 release blog post + adapt website for the launch (@slorber)
    • #7828 misc: change showcase submission process, use GitHub discussion (@slorber)
  • docusaurus-plugin-content-blog
    • #9195 test(blog-plugin): fix ability to generate proper blog website fixture build snapshot (@slorber)
  • create-docusaurus, docusaurus-theme-classic
  • docusaurus

Committers: 131

@slorber slorber added the pr: ignore This PR is not meaningful enough to appear in the changelog. label Oct 26, 2023
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 26, 2023
@johnnyreilly
Copy link
Contributor

exciting!

@netlify
Copy link

netlify bot commented Oct 26, 2023

[V2]

Name Link
🔨 Latest commit 92ff412
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/653aa7a5e9ea7e000858de58
😎 Deploy Preview https://deploy-preview-9453--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify
Copy link

netlify bot commented Oct 26, 2023

[V2]

Name Link
🔨 Latest commit a51cc6f
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/653aa836ced2290008354612
😎 Deploy Preview https://deploy-preview-9453--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟢 91 🟢 97 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 74 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 73 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 66 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 54 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 67 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟢 92 🟢 100 🟢 100 🟢 90 🟠 89 Report

@slorber slorber merged commit 495c793 into main Oct 26, 2023
@slorber slorber deleted the slorber/docusaurus-v3.0.0-rc.1 branch October 26, 2023 18:10
@github-actions
Copy link

Size Change: -36 B (0%)

Total Size: 1.13 MB

Filename Size Change
website/build/assets/js/main.********.js 862 kB -36 B (0%)
ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 117 kB
website/build/assets/css/styles.********.css 113 kB
website/build/index.html 41.4 kB

compressed-size-action

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: ignore This PR is not meaningful enough to appear in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants