facebook/docusaurus v3.0.0

3.0.0

on GitHub

3.0.0 (2023-10-31)

• GitHub PR: #9478
• GitHub release notes: https://github.com/facebook/docusaurus/releases/tag/v3.0.0
• GitHub release discussion: #9481
• Upgrade guide: docusaurus.io/docs/migration/v3

💥 Breaking Change

• create-docusaurus, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic
  • #9451 feat(mdx-loader): upgrade to MDX v3 (@slorber)
• 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
  • #9348 chore: update node engine version 18 (@OzakIOne)
• 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
  • #9189 feat(blog-plugin): limit option for blog feedOptions (@johnnyreilly)
• 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
  • #9026 chore: remove facebook template (@slorber)
• 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
  • #8288 feat: upgrade to MDX v2 (@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)

🚀 New Feature

• create-docusaurus, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic
  • #9451 feat(mdx-loader): upgrade to MDX v3 (@slorber)
• 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
  • #9241 feat: support bun package manager in create-docusaurus (@colinhacks)
• docusaurus-plugin-content-blog
  • #9189 feat(blog-plugin): limit option for blog feedOptions (@johnnyreilly)
• 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
  • #9102 feat(cli): deploy command should allow customizing git config user.name / user.email in deployment branch (#9101) (@amdshrif)
• 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
  • #8288 feat: upgrade to MDX v2 (@slorber)
• 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
  • #8384 feat(eslint-plugin): new prefer-docusaurus-heading rule (@Devansu-Yadav)
• docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus, eslint-plugin
  • #8156 feat: add eslint plugin no-html-links (@JohnVicke)
• 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-theme-common
  • #9446 fix(theme): fix useWindowSize React hydration issue (@slorber)
  • #9276 fix(theme-common): remove useless useSyncExternalStore shim (@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
  • #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
  • #9260 fix(website): fix showcase search input (@biplavmz)
  • #8193 fix(website): mobile scroll on homepage announcement (@maliMirkec)
  • #8042 fix(website): fix blog post social card (@slorber)
• create-docusaurus
  • #9217 fix(create-docusaurus): increase Browserslist support query in dev (@slorber)
• docusaurus-utils, docusaurus
  • #9160 fix(core): handle single quotes inside file paths (@Josh-Cena)
• 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
  • #9051 perf(core): use React 18 startTransition for hydration (@sanjaiyan-dev)
  • #8081 perf(core): move scripts to document head + defer (@sanjaiyan-dev)
• 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-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)
• 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)
• 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)

Committers: 132

• 0x24Karthick (@KarthickSakthi)
• Abhinandan Wadhwa (@abhinandanwadwa)
• Abinash Satapathy (@Abinashbunty)
• Adam Patterson (@adampatterson)
• Adithya Krishna (@adithyaakrishna)
• Ahmad Shrif (@amdshrif)
• Ahmed Mustafa Malik (@amm98d)
• Akshay Bhalotia (@akshaybhalotia)
• Alex (@sashashura)
• Alexander Nguyen (@GalexyN)
• Alexey Pyltsyn (@lex111)
• Andrew Lyons (@andrewnicols)
• Andrés Villanueva (@Villanuevand)
• Anna (@HumbleDeer)
• Anton Kastritskii (@antonk52)
• Antony Onipko (@antonyoni)
• Aolin (@Oreoxmt)
• Aqueeb (@aqueeb)
• Bei Chu (@chubei)
• Billy Chan (@billy1624)
• Biplav Kumar Mazumdar (@biplavmz)
• Bruce (@recallwei)
• Charles Killer (@Foosballfan)
• Chongyi Zheng (@harryzcy)
• Chua Chee How (@rojakcoder)
• Clément Vannicatte (@shortcuts)
• Colin McDonnell (@colinhacks)
• Coupy (@HyeokjinKang)
• Craigory Coppola (@AgentEnder)
• Dan Dascalescu (@dandv)
• Dan Roscigno (@DanRoscigno)
• Danilo Woznica (@danilowoz)
• David J. Felix (@DavidJFelix)
• Debbie O'Brien (@debs-obrien)
• Devansu Yadav (@Devansu-Yadav)
• Dinh Bao Dang (@chillinPanda)
• Dongjoon Lee (@Djunnni)
• Eduardo Mínguez (@e-minguez)
• Eunkwang Shin (@gracefullight)
• Forresst (@forresst)
• Francesco Ciulla (@FrancescoXX)
• Fredrik Stave (@fredrikstave)
• Fxpby (@fxpby)
• Gabriel Csapo (@gabrielcsapo)
• Gareth Dwyer (@sixhobbits)
• Greg Bergé (@gregberge)
• Grégory Heitz (@edno)
• Gustav Tonér (@gazab)
• Hayden Hong (@AFRUITPIE)
• Hidde de Vries (@hidde)
• Hyunseung (@hslee2008)
• JJ Style (@jj-style)
• James Kerrane (@thatrobotdev)
• Jean Humann (@jean-humann)
• Jesper Engberg (@jeengbe)
• Jody Heavener (@jodyheavener)
• Joe Williams (@BubbaJoe)
• John Cao (@jhcao23)
• John Reilly (@johnnyreilly)
• Jordan Manley (@werner33)
• Jorens Merenjanu (@JorensM)
• Joshua Chen (@Josh-Cena)
• Juan Picado (@juanpicado)
• Kolja (@razzeee)
• Lane Goolsby (@lanegoolsby)
• Lorenzo Lewis (@lorenzolewis)
• Maciek Palmowski (@palmiak)
• Manuel (@manuel-rw)
• Marco Kuper (@scubamaggo)
• Marco Stroppel (@mstroppel)
• Marie (@schneegansm)
• Markshawn (@MarkShawn2020)
• Martin Adamko (@attitude)
• Max Schmitt (@mxschmitt)
• Michael Remediakis (@mickremedi)
• Mikey O'Toole (@homotechsual)
• ModupeD (@ModupeD)
• Mu-Jing-Tsai (@moojing)
• Mysterious_Dev (@Mysterious-Dev)
• Naffy Dharni (@knownasnaffy)
• Naman Garg (@NamanGarg2075)
• Nathaniel Tucker (@ntucker)
• Oleksandr Fediashov (@layershifter)
• Oluwatobi Sofela (@oluwatobiss)
• Paul Razvan Berg (@PaulRBerg)
• Pinaki Bhattacharjee (@pinakipb2)
• Raphaël Barbazza (@rbarbazz)
• Rashid (@rashidmya)
• Ryosuke Igarashi (@cm-igarashi-ryosuke)
• SADIK KUZU (@sadikkuzu)
• Sanjaiyan Parthipan (@sanjaiyan-dev)
• Serenus (@Kesyau)
• Shahriar (@ShahriarKh)
• Shashank Kumar (@shawshankkumar)
• Shun Wakatsuki (@shwaka)
• Silvestar Bistrović (@maliMirkec)
• Sujal Gupta (@heysujal)
• Sunghyun Cho (@anaclumos)
• Surav Shrestha (@suravshrestha)
• Sébastien Lorber (@slorber)
• Tamal Anwar Chowdhury (@tamalchowdhury)
• Tarun Chauhan (@tarunrajput)
• Tatsunori Uchino (@tats-u)
• Thad Guidry (@thadguidry)
• Tom Mrazauskas (@mrazauskas)
• Viktor Malmedal (@JohnVicke)
• Waldir Pimenta (@waldyrious)
• Wan Sim (@0420syj)
• Webber Takken (@webbertakken)
• Will Ceolin (@wceolin)
• Yangshun Tay (@yangshun)
• Zwyx (@Zwyx)
• @Dr-Electron
• @FlorinaPacurar
• @Mogyuchi
• @Sainan
• @VinceCYLiao
• @allyw2002
• @bitpredator
• @conlacda
• @dawei-wang
• @la55u
• @mcallisto
• @prateekbytes
• @qwerzl
• @rsteele6
• @samatt14
• @thedevwonder
• @yosukekato165
• ozaki (@OzakIOne)
• sykp241095 (@sykp241095)
• 初冬 (@chudongvip)