3.0.0-alpha.0

3.0.0-alpha.0 (2023-06-15)

💥 Breaking Change

• 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)

2.4.1

2.4.1 (2023-05-15)

🐛 Bug Fix

• docusaurus-theme-classic, docusaurus-theme-common
  • #8971 fix(theme): fix collapsible sidebar behavior when prefers-reduced-motion (@slorber)
• docusaurus-theme-translations
  • #8933 fix(theme-translations): fix Turkish translation for aria label "Enter key" (@LiberaTeMetuMortis)
• docusaurus
  • #8908 fix(core): Correct yarn upgrade command for yarn 2.x (@andrewnicols)
• docusaurus-plugin-content-blog, docusaurus-theme-common, docusaurus-utils-common, docusaurus
  • #8909 fix(theme): add __ prefix to technical anchors, search crawlers (Algolia) should ignore them (@slorber)
• docusaurus-theme-common
  • #8906 fix(theme-common): fix collapsible component with prefers-reduced-motion (@slorber)
  • #8873 fix(theme-common): fix confusing theme error message: bad sidebar id suggestions (@slorber)
• docusaurus-utils
  • #8874 fix(utils): handle Markdown links with spaces to route correctly (@morsko1)
• docusaurus-theme-classic, docusaurus-theme-translations
  • #8842 fix(theme-translations): remove redundant navigation text in aria label (@tarunrajput)
• create-docusaurus
  • #8831 fix(create): add missing await (@SACHINnANYAKKARA)

💅 Polish

• docusaurus-theme-classic
  • #8862 refactor(theme): expose copy, success and word-wrap icons as standalone components (@armano2)

Committers: 7

• Aleksandr Vladykin (@morsko1)
• Andrew Lyons (@andrewnicols)
• Armano (@armano2)
• MetuMortis (@LiberaTeMetuMortis)
• Sachin Nanayakkara (@SACHINnANYAKKARA)
• Sébastien Lorber (@slorber)
• Tarun Chauhan (@tarunrajput)

2.4.0

2.4.0 (2023-03-23)

Blog post: https://docusaurus.io/blog/releases/2.4/

🚀 New Feature

• docusaurus-plugin-content-docs, docusaurus-theme-classic
  • #8236 feat(content-docs): add support for sidebar item category/link descriptions in generated index page (@ZarakiKanzaki)
• docusaurus-theme-classic
  • #8708 feat(theme): allow to load a Docusaurus page with theme from query-string: ?docusaurus-theme=dark (@slorber)
  • #8616 feat(theme): add ability to translate navbar+footer logo alt text (@Mysterious-Dev)
• docusaurus-remark-plugin-npm2yarn
  • #8690 feat(npm-to-yarn): add support for PnPm and custom converters (@armano2)
• docusaurus
  • #8677 feat(core): add script env variables: NODE_ENV + BABEL_ENV + DOCUSAURUS_CURRENT_LOCALE (temporary i18n workaround) (@slorber)
• docusaurus-theme-classic, docusaurus-theme-common
  • #8674 feat(theme-classic): respect prefers-reduced-motion: reduce mediaquery, bump Infima to alpha.43 (@slorber)
• docusaurus-theme-translations
  • #8668 feat(theme-translations): add Hungarian theme translations (@trueqap)
  • #8631 feat(theme-translations): add Norwegian (Bokmål) theme translation (@dr0nn1)
• docusaurus-theme-common
  • #8656 feat(theme-common): allow passing a string for details summary (@pReya)
• docusaurus-plugin-google-gtag
  • #8620 feat(gtag-plugin): gtag should support multiple tracking ids, notably for the UA => GA4 transition (@slorber)

🐛 Bug Fix

• docusaurus-theme-classic
  • #8803 fix(theme): codeblock buttons should be kept on the right when using RTL locale (@Vishruta-Patil)
  • #8615 fix(theme): improve color toggle when using dark navbar (@dewanshDT)
  • #8699 fix(theme-classic): fix tab focus bug in dropdown (#8697) (@kagankan)
• docusaurus-theme-classic, docusaurus-theme-common
  • #8801 fix(theme): allow tabs children to be falsy (@Josh-Cena)
• docusaurus-theme-common, docusaurus-theme-search-algolia
  • #8757 fix(search): search page should react to querystring changes + cleanup/refactor (@slorber)
• docusaurus
  • #8746 fix(core): baseUrl error banner link anchor case (@slorber)
• docusaurus-theme-translations
  • #8744 fix(theme-translations): fix wrong arabic words (tip/next) (@Anasqx)

💅 Polish

• create-docusaurus
  • #8712 polish(create-docusaurus): the starter template should use a navbar item "docSidebar" instead of "doc" (less fragile on updates) (@biplavmz)
• docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-common, docusaurus
  • #8735 polish(theme): better error messages on navbar item rendering failures + ErrorCauseBoundary API (@tannerdolby)
• docusaurus-theme-classic, docusaurus-theme-common, docusaurus
  • #8736 polish(core): better styling for error screens (@tannerdolby)

Committers: 14

• Anas (@Anasqx)
• Armano (@armano2)
• Davide Donadio (@ZarakiKanzaki)
• Dewansh Thakur (@dewanshDT)
• Joshua Chen (@Josh-Cena)
• Kagan (@kagankan)
• Moritz Stückler (@pReya)
• Mysterious_Dev (@Mysterious-Dev)
• Petter Drønnen (@dr0nn1)
• Sébastien Lorber (@slorber)
• Tanner Dolby (@tannerdolby)
• TrueQAP (@trueqap)
• Vishruta Patil (@Vishruta-Patil)
• @biplavmz

2.3.1

2.3.1 (2023-02-03)

🐛 Bug Fix

• docusaurus-theme-common
  • #8628 fix(theme-common): fix issue in tab scroll position restoration on tab click (@slorber)
  • #8619 fix(theme-common): localStorage utils dispatch too many storage events leading to infinite loop (@slorber)
  • #8618 fix(theme-common): prepare usage of useSyncExternalStore compatibility with React 18 (@slorber)
• docusaurus-theme-classic, docusaurus-theme-common
  • #8593 fix(theme-classic): allow rendering single tab item (@Josh-Cena)
• docusaurus-utils
  • #8606 fix(utils): handle CRLF when parsing MDX imports (@scastiel)
• docusaurus-preset-classic
  • #8597 fix(preset-classic): install the right plugin for googleTagManager (@Josh-Cena)

💅 Polish

• docusaurus-theme-translations
  • #8614 chore(theme-translations): complete zh translations (@Josh-Cena)

🤖 Dependencies

• docusaurus-plugin-client-redirects, docusaurus-theme-search-algolia, docusaurus
  • #8610 chore(deps): bump eta from 1.12.3 to 2.0.0 (@dependabot[bot])

Committers: 3

• Joshua Chen (@Josh-Cena)
• Sébastien Castiel (@scastiel)
• Sébastien Lorber (@slorber)

2.3.0

2.3.0 (2023-01-26)

🚀 New Feature

• docusaurus-theme-translations
  • #8541 feat(theme-translations): default translations for Slovenian (sl-SI) (@MatijaSi)
• docusaurus-plugin-content-blog
  • #8378 feat(blog): add options.createFeedItems to filter/limit/transform feed items (@johnnyreilly)
• docusaurus-theme-classic, docusaurus-theme-common, docusaurus
  • #8225 feat(theme-classic): store selected tab in query string. (@mturoci)
• docusaurus
  • #8397 feat(core): deploy CLI - add support for git url "insteadOf": use 'remote get-url' to determine source repo url (@friederbluemle)
• docusaurus-theme-search-algolia
  • #8428 feat(theme-algolia): add option.replaceSearchResultPathname to process/replaceAll search result urls
• docusaurus-plugin-google-tag-manager
  • #8470 feat(plugin-google-tag-manager): add new google-tag-manager plugin + deprecate google-analytics plugin

🐛 Bug Fix

• docusaurus-mdx-loader
  • #8303 fix(mdx-loader): support nested admonitions
  • #8282 fix(mermaid): fix Mermaid integration for v9.2 release
• docusaurus-theme-common
  • #8539 fix(algolia): make search footer respect searchPagePath (@Josh-Cena)
• docusaurus
  • #8538 fix(core): avoid hash collision when generating chunk names (@Josh-Cena)
  • #8481 fix(core): explicitly define CopyWebpackPlugin toType: 'dir' (@Thomascogez)
  • #8342 fix(core): normalize input for poll option (@mhnaeem)
• docusaurus-theme-classic, docusaurus
  • #8445 fix(theme-classic) extract HomeBreadcrumbItem + fix swizzle bugs (@3v0k4)
• docusaurus-theme-search-algolia
  • #8462 fix(search-algolia): pass custom transformItems function to SearchBar (@mturoci)
• docusaurus-theme-classic, docusaurus-theme-common
  • #8486 fix(theme): refactor Tabs, make groupId + queryString work fine together (@slorber)
• docusaurus-theme-classic
  • #8463 fix(theme-classic): content container grow to take all the available space (@Djunnni)
  • #8328 fix(theme): preserve sidebar height on collapse (@0916dhkim)
  • #8350 fix(theme): forward className prop in theme-classic's Heading (@JoshuaKGoldberg)
• docusaurus-theme-translations
  • #8424 fix(translations): typo in lastUpdatedAtBy Vietnamese translation (@slorber)
  • #8289 fix(theme-translations): complete Turkish theme translations
  • #8406 fix(translations): complete farsi theme translations
  • #8450 fix(theme-translations): complete Vietnamese theme translations
  • #8525 chore(theme-translations): complete pl translations
• docusaurus-plugin-content-blog
  • #8381 fix(content-blog): blog Atom feed id + RSS feed guid should be fully qualified urls (@johnnyreilly)
• docusaurus-plugin-content-docs
  • #8275 fix(content-docs): add trailing slash to contentDirs, before passing it to isMDXPartial (@denis-alkhelali)
• docusaurus-utils
  • #8314 fix(utils): allow partially backticked markdown h1 contentTitles (@JoshuaKGoldberg)
• create-docusaurus, docusaurus-theme-classic
  • #8279 fix(create-docusaurus): improve init template misleading doc + add Docuaurus social card (@slorber)

💅 Polish

• docusaurus-theme-classic, docusaurus
  • #8445 fix(theme-classic) extract HomeBreadcrumbItem + fix swizzle bugs (@3v0k4)
• docusaurus-theme-translations
  • #8423 fix(translations): complete Chinese theme translations (@SJFCS)
  • #8312 fix(theme-translations): complete Swedish theme translations (@stnor)
• eslint-plugin
  • #8281 feat(eslint-plugin): add plugin to exported configs (@lachieh)

Committers: 16

• Danny Kim (@0916dhkim)
• Denis Al-Khelali (@denis-alkhelali)
• Dongjoon Lee (@Djunnni)
• Frieder Bluemle (@friederbluemle)
• John Reilly (@johnnyreilly)
• Josh Goldberg (@JoshuaKGoldberg)
• Joshua Chen (@Josh-Cena)
• Lachlan Heywood (@lachieh)
• Matija Sirk (@MatijaSi)
• Muhammad Hammad (@mhnaeem)
• Riccardo (@3v0k4)
• Stefan Norberg (@stnor)
• Sébastien Lorber (@slorber)
• Thomas.CA (@Thomascogez)
• @mturoci
• 宋锦丰 (@SJFCS)

2.2.0

2.2.0 (2022-10-29)

• Blog post
• Tweet

🚀 New Feature

• docusaurus-plugin-client-redirects
  • #8227 feat(plugin-client-redirects): keep the query string + hash (@Xabilahu)
• docusaurus
  • #8210 feat(core): add --config param to swizzle command (@e-im)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-mermaid, docusaurus-types, docusaurus
  • #7490 feat: support mermaid code blocks in Markdown (@sjwall)
• docusaurus-types, docusaurus
  • #8151 feat(core): siteConfig.headTags API to render extra tags in document head (@johnnyreilly)

🐛 Bug Fix

• docusaurus-plugin-ideal-image
  • #8250 fix(ideal-image): do not pass down img prop (@lex111)
• docusaurus-theme-common
  • #8246 fix(mdx-loader): properly unwrap mdxAdmonitionTitle placeholder (@Josh-Cena)
• docusaurus-plugin-content-docs
  • #8234 fix(plugin-content-docs): fix error message context (error cause) when doc processing fails (@shanpriyan)
• docusaurus-theme-classic, docusaurus-theme-translations
  • #8207 fix(theme-classic): hamburger menu control navigation by keyboard (@jeferson-sb)
• docusaurus-theme-classic, docusaurus-theme-common
  • #8204 fix(theme-classic): fix SkipToContent without JS , refactor, make it public theming API (@mturoci)
  • #8059 fix(theme): preserve url ?search#hash on navbar version/locale dropdowns navigations (@slorber)
• docusaurus
  • #8192 fix(core): throw error for invalid URL in config file (@forgeRW)
• docusaurus-theme-classic
  • #8174 fix(theme): announce theme switches (@mturoci)
  • #8190 fix(theme): add more tag names to inline code element set (@Josh-Cena)
  • #8163 fix(theme): mobile navbar & skipToContent should cover announcementBar (@adnanhashmi09)
  • #8068 fix(theme): preserve line breaks when copying code with showLineNumbers in Firefox (@LittleboyHarry)
• docusaurus-utils
  • #8137 fix(utils): remove non-ASCII limitation for path normalization (@birjj)
  • #8158 fix(content-blog): make RSS feed generation work with slugs with .html extension (@Pranav2612000)
• docusaurus-theme-translations
  • #8105 fix(theme-translations): complete turkish theme default translations (@ramazansancar)
  • #8087 fix(theme-translations): remove extra vi translations (@namnguyenthanhwork)
• docusaurus-plugin-client-redirects
  • #8067 fix(redirect): tolerate trailing slash difference if config is undefined (@Josh-Cena)

💅 Polish

• docusaurus-theme-translations
  • #8253 chore(theme-translations): complete ru translations (@lex111)
  • #8243 chore(theme-translations): complete French translations (@forresst)
  • #8075 fix(theme-translation): complete Japanese theme default translation (@pasora)
• docusaurus
  • #8159 fix(core): throw error for invalid URL in config file (@forgeRW)
  • #8109 feat(core): prefetch on mobile touchstart (@sanjaiyan-dev)
• docusaurus-theme-classic
  • #8161 fix(theme): do not show tab content when tabbing over it; show after selection only (@mturoci)
  • #8062 refactor(theme): remove hard-coded tag border-radius (@homotechsual)
• docusaurus-utils-validation, docusaurus
  • #8066 fix(core): normalize slashes for url/baseUrl instead of throwing (@Josh-Cena)

Committers: 22

• Adnan Hashmi (@adnanhashmi09)
• Alexey Pyltsyn (@lex111)
• Forresst (@forresst)
• Jan Peer Stöcklmair (@JPeer264)
• Jeferson S. Brito (@jeferson-sb)
• Johan Fagerberg (@birjj)
• John Reilly (@johnnyreilly)
• Joshua Chen (@Josh-Cena)
• LittleboyHarry (@LittleboyHarry)
• Masahiko Hara (@pasora)
• Mikey O'Toole (@homotechsual)
• Nguyễn Thành Nam (@namnguyenthanhwork)
• Pranav Joglekar (@Pranav2612000)
• Ramazan SANCAR (@ramazansancar)
• Sam Wall (@sjwall)
• Sanjaiyan Parthipan (@sanjaiyan-dev)
• Shanmughapriyan S (@shanpriyan)
• Sébastien Lorber (@slorber)
• Xabier Lahuerta Vazquez (@Xabilahu)
• @forgeRW
• @mturoci
• evan (@e-im)

2.1.0

2.1.0 (2022-09-01)

🚀 New Feature

• docusaurus-theme-classic, docusaurus-theme-common
  • #8008 feat(theme): ability to use <DocCardList> without items prop, on any doc page (@slorber)
• docusaurus-plugin-content-docs, docusaurus-theme-classic
  • #7963 feat(docs): allow to configure noIndex per doc version (@slorber)
  • #7949 feat(plugin-docs): docs sidebar item link: support "autoAddBaseUrl" attribute (@slorber)
• docusaurus-theme-translations
  • #7953 feat(theme): adds Ukrainian default theme translations (@b-ovsepian)

🐛 Bug Fix

• create-docusaurus
  • #8032 fix(create-docusaurus): tutorial and init template improvements (@slorber)
• docusaurus-preset-classic
  • #8029 fix(preset-classic): broken link in "unrecognized keys" error message (@mdubus)
• docusaurus
  • #7977 fix(core): preload should support encoded page links (@adventure-yunfei)
  • #7996 fix(core): CLI command write-translations should extract translations from @Docu… (@slorber)
  • #7952 fix(core): allow overriding ssr/dev template meta tags (@slorber)
• docusaurus-plugin-sitemap
  • #7964 fix(sitemap): filter all routes with robots meta containing noindex (@slorber)
• docusaurus-theme-classic
  • #7910 fix(theme-classic): code block line number display with line wrapping (@yzhe819)
  • #7786 fix: collapse siblings when first category is selected (@whiteand)

💅 Polish

• docusaurus-theme-classic
  • #7982 fix(theme): add aria-label to skip to content link region (@YoniChechik)
  • #7940 refactor(theme-classic): split AnnouncementBar, increase z-index, use shadow (@slorber)
  • #7876 refactor(theme-classic): make tag text visually certered (@Kosai106)
• docusaurus-utils
  • #7941 feat(core): add new Webpack file-loader extensions: avif, mov, mkv, mpg, avi... (@slorber)
• docusaurus-theme-classic, docusaurus-types
  • #7942 feat(theme-classic): use lang attribute in navbar locale dropdown items (@slorber)
• docusaurus-theme-translations
  • #7928 chore(theme-translations): complete vi translations (@datlechin)

📝 Documentation

• create-docusaurus
  • #8032 fix(create-docusaurus): tutorial and init template improvements (@slorber)
• 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-ideal-image, docusaurus-plugin-sitemap, docusaurus-theme-classic
  • #7905 docs: remove mention of beta (@Josh-Cena)

Committers: 10

• Bagdasar Ovsepyan (@b-ovsepian)
• Joshua Chen (@Josh-Cena)
• Kevin Østerkilde (@Kosai106)
• Morgane Dubus (@mdubus)
• Ngô Quốc Đạt (@datlechin)
• Sébastien Lorber (@slorber)
• Yoni Chechik (@YoniChechik)
• @whiteand
• @yzhe819
• adventure-yunfei (@adventure-yunfei)

2.0.1

2.0.1 (2022-08-01)

Fix bad npm publish of 2.0.0

Committers: 1

• Sébastien Lorber (@slorber)

2.0.0

2.0.0 (2022-08-01)

Bad npm publish, please use 2.0.1

💅 Polish

• docusaurus
  • #7781 refactor(core): log Docusaurus & Node version before exiting (@Josh-Cena)

Committers: 2

• Joshua Chen (@Josh-Cena)
• Sébastien Lorber (@slorber)

2.0.0-rc.1

2.0.0-rc.1 (2022-07-14)

🐛 Bug Fix

• docusaurus
  • #7776 fix(core): swizzle --eject js should not copy theme .d.ts files (@slorber)
  • #7750 fix(deploy): revert "feat(deploy): copy local git config to tmp repo (#7702)" (@ghostsquad)
• docusaurus-plugin-sitemap
  • #7774 fix(sitemap): complete gracefully when all pages have noIndex meta (@Josh-Cena)
• docusaurus-theme-classic
  • #7771 chore: bump Infima to 0.2.0-alpha.42, fix a:hover link bug (@slorber)
  • #7755 fix(theme-classic): validate options properly (@Josh-Cena)
  • #7752 fix(theme-classic): fix Layout theme height CSS (@LichLord91)
• docusaurus-migrate
  • #7766 fix(migrate): import siteConfig with file extension (@Josh-Cena)
• docusaurus-theme-search-algolia
  • #7761 fix(algolia-search): test for canUseIntersectionObserver (@RoiArthurB)

💅 Polish

• docusaurus-theme-translations
  • #7762 chore(theme-translations): complete ko translations (@anaclumos)

📝 Documentation

• docusaurus-plugin-content-docs
  • #7706 docs: release process, versioning, breaking changes, public API surface (@slorber)

🔧 Maintenance

• docusaurus-theme-classic
  • #7777 refactor(theme): fix duplicate page metadata usage (@slorber)
  • #7771 chore: bump Infima to 0.2.0-alpha.42, fix a:hover link bug (@slorber)

Committers: 11

• Arthur Brugière (@RoiArthurB)
• Bruce Song (@recallwei)
• Evan (@DigiPie)
• Jeffrey Aven (@jeffreyaven)
• Joshua Chen (@Josh-Cena)
• Sunghyun Cho (@anaclumos)
• Sébastien Lorber (@slorber)
• The Nguyen (@treoden)
• Wes McNamee (@ghostsquad)
• @LichLord91
• 凱恩 Kane (@Gary50613)