Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

docusaurus

facebook51.7kMIT1.14.7

Easy to Maintain Open Source Documentation Websites

documentation, websites, open source, docusaurus

readme

Docusaurus

Docusaurus

npm version CircleCI Status PRs Welcome Chat code style: prettier Tested with Jest Netlify Status

Introduction

Docusaurus is a project for easily building, deploying, and maintaining open source project websites.

  • Simple to Start Docusaurus is built to be easy to get up and running in as little time possible. We've built Docusaurus to handle the website build process so you can focus on your project.
  • Localizable Docusaurus ships with localization support via CrowdIn. Empower and grow your international community by translating your documentation.
  • Customizable While Docusaurus ships with the key pages and sections you need to get started, including a home page, a docs section, a blog, and additional support pages, it is also customizable as well to ensure you have a site that is uniquely yours.

Installation

Docusaurus is available as the docusaurus package on npm.

We have also released the docusaurus-init package to make getting started with Docusaurus even easier.

Contributing

We've released Docusaurus because it helps us better scale and support the many OSS projects at Facebook. We hope that other organizations can benefit from the project. We are thankful for any contributions from the community.

Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docusaurus.

Beginner Friendly Bugs

To help you get your feet wet and get you familiar with our contribution process, we have a list of beginner friendly bugs that might contain smaller issues to tackle first. This is a great place to get started.

Contact

We have a few channels for contact:

  • Discord with two text channels:
    • #docusaurus-users for those using Docusaurus.
    • #docusaurus-dev for those wanting to contribute to the Docusaurus core.
  • @docusaurus on Twitter
  • GitHub Issues

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

Docusaurus is MIT licensed.

The Docusaurus documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.

changelog

Docusaurus Changelog

3.8.1 (2025-06-06)

:bug: Bug Fix

  • docusaurus-theme-classic
    • #11242 fix(theme): fix unability to navigate to category's page when browsing its children items (@slorber)
  • docusaurus-plugin-css-cascade-layers
    • #11241 fix(css-cascade-layers): fix windows css cascade layers bug (@slorber)
  • docusaurus
    • #11222 fix(bundler): fix docusaurus start using concatenateModules: true (@slorber)
    • #11217 fix: include Arc to supported Chromium Browsers (@wellwelwel)
    • #11205 fix(core): fix docusaurus start error for macOS users with no Chromium-based browser (@slorber)
  • docusaurus-types

:running_woman: Performance

  • docusaurus-plugin-content-blog, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-types, docusaurus-utils, docusaurus
    • #11211 perf: avoid duplicated git log calls in loadContent() and postBuild() for untracked Git files (@slorber)

:wrench: Maintenance

  • docusaurus-faster
  • docusaurus-plugin-content-docs
    • #11230 refactor(docs): extract loadVersion() without changing the behavior (@slorber)
  • Other

Committers: 7

3.8.0 (2025-05-26)

:rocket: New Feature

  • docusaurus-plugin-css-cascade-layers, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-types, docusaurus
    • #11142 feat(theme): new CSS cascade layers plugin + built-in v4.useCssCascadeLayers future flag (@slorber)
  • docusaurus
  • docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus
    • #11090 feat(theme): make it possible to provide your own page title formatter (@slorber)
  • docusaurus-plugin-content-pages
    • #11088 feat(pages): Support frontMatter.slug like docs and blog plugins (@slorber)
  • docusaurus-faster, docusaurus
  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations
    • #10987 feat(theme): Allow resetting colorMode to System/OS value (@slorber)
  • docusaurus-remark-plugin-npm2yarn
  • docusaurus-theme-classic, docusaurus-theme-common
    • #10945 feat(theme): add theme layout stable CSS classes (@slorber)
    • #10846 feat(theme): code block showLineNumbers=start metastring (@slorber)
  • docusaurus-faster, docusaurus-plugin-content-docs, docusaurus-types, docusaurus
    • #10931 feat(core): Docusaurus Faster - Rspack Persistent Cache (@slorber)
  • docusaurus-theme-classic
    • #10852 feat(theme): add versions attribute to docsVersionDropdown navbar item (@hrumhurum)
  • docusaurus-types, docusaurus
    • #10826 feat(core): Docusaurus Faster - SSG worker threads (@slorber)
  • docusaurus-plugin-sitemap, docusaurus-types, docusaurus
    • #10850 feat(core): new postBuild({routesBuildMetadata}) API, deprecate head attribute + v4 future flag (@slorber)

:bug: Bug Fix

  • docusaurus-plugin-content-blog
  • docusaurus-plugin-content-blog
  • docusaurus-plugin-content-docs
    • #11179 fix(mdx-loader): remove opt-in for mdx dependency file (@slorber)
    • #10875 fix(docs): versioning CLI should copy localized translation file current.json to version-<v>.json (@jkboxomine)
  • create-docusaurus
    • #11157 fix(create-docusaurus): Improve init template README, fix headings and remove $ in bash code blocks (@arienshibani)
  • docusaurus-theme-common
    • #11153 fix(theme): restore former code block theme-common internal APIs (@slorber)
    • #11046 fix(theme): Fix code block magic comments with CRLF line breaks bug (@coder-xiaomo)
    • #10989 fix(theme): mobile drawer history blocker should be rendered conditionally (workaround) (@slorber)
    • #10954 fix(theme): fix useColorMode().colorMode leading to React hydration mismatches (@slorber)
  • docusaurus-theme-classic
    • #11085 fix(theme): add missing rel="tag" attribute for docs/blog tags (@slorber)
    • #10999 fix(theme): CodeBlock should accept title of ReactNode type (@lebalz)
    • #10705 fix(theme): only render secondaryMenu if it should be shown (@hidde)
    • #10898 fix(theme): a11y fix on mobile DropdownNavbarItem (@mxschmitt)
    • #10909 fix(theme): apply docs sidebar_class_name in DocCard + better dogfooding (@slorber)
    • #10849 fix(theme): fix <DocCard> height inconsistency (@hichemfantar)
    • #10866 fix(theme): Hide code block buttons before React hydration (@kennethormandy)
  • docusaurus-theme-classic, docusaurus-theme-translations
    • #11053 fix(theme): navbar mobile sidebar should allow clicking dropdown parent link (@slorber)
  • docusaurus-utils
  • docusaurus-theme-translations
  • docusaurus-plugin-ideal-image
    • #11026 fix(ideal-image): fix waypoint initial scroll bug (@slorber)
    • #11014 fix(ideal-image): Internalize react-waypoint dependency, fix React 19 compatibility (@slorber)
    • #10910 fix(ideal-image): Add issuer to ideal-image Webpack loader (@slorber)
  • docusaurus-mdx-loader
    • #11004 fix(mdx-loader): refactor and fix heading to toc html value serialization (@slorber)
  • docusaurus-module-type-aliases
  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations
    • #10987 feat(theme): Allow resetting colorMode to System/OS value (@slorber)
  • create-docusaurus, docusaurus-utils
    • #10958 fix(create-docusaurus): fix CLI and remove shelljs escapeShellArg util (@slorber)
  • docusaurus-mdx-loader, docusaurus-plugin-content-docs
    • #10934 fix(docs): fix mdx loader cache invalidation bug on versions changes (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common
    • #10888 fix(seo): docs breadcrumb structured data should use JSON-LD and filter unliked categories (@johnnyreilly)
  • docusaurus-theme-classic, docusaurus-theme-common
    • #10886 fix(theme): collapse doc sidebar category on label click if active (@slorber)
  • docusaurus
    • #10915 fix(core): use os.availableParallelism() for SSG worker threads count (@slorber)
  • docusaurus-plugin-content-docs, docusaurus-theme-classic
    • #10847 fix(theme): Fix <DocCardList> usage on docs at root of a sidebar (@slorber)
  • docusaurus-plugin-svgr, docusaurus-types, docusaurus-utils, docusaurus
  • docusaurus-logger

:running_woman: Performance

  • docusaurus-utils, docusaurus
    • #11178 perf(core): disable Rspack parallelCodeSplitting temporarily (@slorber)
  • docusaurus
    • #11177 perf(core): fix bad value for mergeDuplicateChunks (typo) (@slorber)
    • #11170 perf(core): add default for DOCUSAURUS_SSG_WORKER_THREAD_RECYCLER_MAX_MEMORY (@slorber)
    • #11166 feat(core): expose opt-in env variable for SSG thread recycling (@slorber)
    • #11072 perf(core): remove bundler optimization.removeAvailableModules (@slorber)
    • #11067 feat(core): enable Rspack parallelCodeSplitting (@slorber)
    • #11037 refactor(core): remove clean-webpack-plugin (@slorber)
    • #11007 perf(core): Optimize docusaurus start/serve, fix openBrowser() perf issue on macOS (@slorber)
  • docusaurus-bundler, docusaurus-faster, docusaurus
    • #11176 perf(bundler): fine-tuning of Webpack/Rspack optimizations (@slorber)
  • docusaurus-utils
  • docusaurus-logger, docusaurus
    • #11162 perf(core): optimize SSG collected data memory and worker thread communication (@slorber)
  • docusaurus-bundler, docusaurus
    • #10956 refactor: remove react-dev-utils (CRA) dependency, internalize code (@slorber)
  • docusaurus-theme-classic
  • docusaurus-types, docusaurus
    • #10826 feat(core): Docusaurus Faster - SSG worker threads (@slorber)

:nail_care: Polish

  • docusaurus-theme-live-codeblock
    • #11120 fix(theme): improve color contrast of live code block header (@JackHowa)
  • docusaurus-theme-translations

:memo: Documentation

  • #11181 docs: adjust the Docusaurus release process documentation to our new simpler process (@slorber)
  • #11180 docs(ideal-image): Add warning for pnpm 10+ and sharp install script (@slorber)
  • #11137 docs(deploy): remove layer0 from deployment docs (@PaiJi)
  • #10822 docs(website): Comparison with Rspress (@DevJoaoLopes)

:robot: Dependencies

:wrench: Maintenance

  • docusaurus-mdx-loader, docusaurus-utils
    • #11168 chore: add Node 24 to CI + fix deprecation warnings (@slorber)
  • docusaurus-plugin-content-blog
  • docusaurus-mdx-loader, docusaurus-theme-common, docusaurus-theme-live-codeblock
    • #11077 refactor(live-codeblock): refactor live code block theme components (@slorber)
  • Other
  • docusaurus-faster
  • docusaurus-theme-mermaid
  • docusaurus-mdx-loader
  • docusaurus-theme-classic, docusaurus-theme-common
    • #11062 refactor(theme): introduce CodeBlockContextProvider + split into smaller components (@slorber)
    • #11059 refactor(theme): CodeBlock, centralize metadata parsing + refactor theme component (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-common
    • #11058 refactor(theme): refactor CodeBlock parseLines logic + use inline snapshots to ease review (@slorber)
  • docusaurus-faster, docusaurus
  • docusaurus-plugin-ideal-image
    • #11010 refactor(ideal-image-plugin): internalize legacy component code (@slorber)
  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-mermaid, docusaurus-theme-search-algolia
  • docusaurus-cssnano-preset, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-remark-plugin-npm2yarn, eslint-plugin, stylelint-copyright
  • docusaurus-bundler, docusaurus
    • #10956 refactor: remove react-dev-utils (CRA) dependency, internalize code (@slorber)
  • create-docusaurus, docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
    • #10358 refactor: replace unmaintained shelljs dependency by execa (@OzakIOne)
  • docusaurus-theme-search-algolia
  • docusaurus-plugin-debug
    • #10903 chore(plugin-debug): upgrade react-json-view-lite to v2.3.0 for react 19 (@reece-white)
    • #10819 chore(plugin-debug): upgrade react-json-view-lite to v2, prepare for React 19 (@slorber)
  • create-docusaurus
    • #10871 refactor(create-docusaurus): add future.v4 flag to init templates (@slorber)

Committers: 38

3.7.0 (2025-01-03)

:rocket: New Feature

  • docusaurus-faster, docusaurus
    • #10800 feat(core): Turn Rspack incremental on by default (again) (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-theme-classic
    • #10768 feat(blog): Add author social icons for bluesky, mastodon, threads, twitch, youtube, instagram (@GingerGeek)
  • 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-rsdoctor, docusaurus-plugin-sitemap, docusaurus-plugin-svgr, docusaurus-plugin-vercel-analytics, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-mermaid, docusaurus-theme-search-algolia, docusaurus-types, docusaurus
  • docusaurus-plugin-content-blog
  • docusaurus-module-type-aliases, docusaurus-plugin-svgr, docusaurus-preset-classic, docusaurus-types, docusaurus-utils, docusaurus

:bug: Bug Fix

  • docusaurus-remark-plugin-npm2yarn
    • #10803 fix(npm-to-yarn): add missing npm-to-yarn converter for Bun (@Lehoczky)
  • docusaurus-theme-classic, docusaurus-theme-common
    • #10796 fix(theme): Footer Column/Link should merge provided className (@slorber)
  • docusaurus-bundler, docusaurus-theme-common
    • #10786 fix(core): fix React hydration errors, change html minifier settings (@slorber)
  • docusaurus-theme-common
    • #10782 fix(theme-common): code block magic comments should support SQL block comments (@WillBlack403)
  • docusaurus-theme-translations
    • #10783 fix(theme-translations): Add missing Dutch (nl) theme translations (@janaukema)
    • #10760 fix(theme-translation): add missing Korean (ko) theme translations (@effozen)
  • docusaurus-plugin-content-docs
    • #10754 fix(docs): fix sidebar item visibility bug for category index (@slorber)
  • docusaurus
    • #10727 fix(core): fix codegen routesChunkName possible hash collision (@slorber)
  • docusaurus-mdx-loader
    • #10723 fix(mdx-loader): fix md image paths with spaces bug related to transformImage encoding problem (@slorber)

:memo: Documentation

:robot: Dependencies

:wrench: Maintenance

  • Other
  • docusaurus-theme-search-algolia
  • docusaurus
    • #10798 refactor(core): Use Intl native API to get locale direction, remove rtl-detect depend… (@slorber)
    • #10747 refactor(core): swizzle wrap should use ReactNode instead of JSX.Element (@slorber)
  • create-docusaurus, docusaurus-mdx-loader, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, 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-types, docusaurus
  • docusaurus-theme-common
    • #10728 refactor(theme-common): change storageUtils useSyncExternalCode getSnapshot workaround (@slorber)

Committers: 14

3.6.3 (2024-11-22)

:bug: Bug Fix

  • docusaurus

Committers: 1

3.6.2 (2024-11-19)

:bug: Bug Fix

  • docusaurus-module-type-aliases
    • #10693 fix(types): add missing ambiant TS declarations for .md / .mdx partials (@slorber)
  • docusaurus-theme-translations
    • #10688 fix(theme-translation): add and update Japanese translations (@Ryoga-exe)
  • docusaurus
    • #10685 fix(cli): docusaurus --help should print plugin commands using extendCli() (@slorber)
  • docusaurus-bundler
    • #10680 fix(bundler): allow CSS nesting by default, restore postcss-preset-env (@slorber)
  • create-docusaurus
    • #10676 fix(create-docusaurus): add ts exclude to TS init template (@slorber)
  • docusaurus-bundler, docusaurus-faster, docusaurus
    • #10648 fix(faster): Upgrade to Rspack 1.1.1, fix build progress bar display (@slorber)

:wrench: Maintenance

  • #10691 chore(ci): retry yarn install to ignore temporary network errors (@slorber)

Committers: 5

3.6.1 (2024-11-08)

:bug: Bug Fix

  • docusaurus
    • #10658 fix(core): bundler should not minimize static assets (@slorber)
  • docusaurus-bundler, docusaurus-faster, docusaurus-utils-common, docusaurus-utils
    • #10649 fix(faster,utils): fix faster/types peerDependencies (@slorber)

:nail_care: Polish

  • docusaurus-bundler, docusaurus-types, docusaurus
    • #10655 refactor(faster,bundler,core): improve js loader DX (@slorber)

:memo: Documentation

:wrench: Maintenance

  • docusaurus-mdx-loader
    • #10651 refactor(mdx-loader): streamline typescript usage for remark plugin types (@lebalz)
  • Other

Committers: 2

3.6.0 (2024-11-04)

:rocket: New Feature

  • docusaurus-plugin-content-blog, docusaurus-theme-classic
    • #10586 feat(blog): Add frontMatter.title_meta to override title for SEO (@ilg-ul)
  • docusaurus
    • #10600 feat(cli): build/deploy should allow multiple --locale options (@slorber)
  • docusaurus-logger
  • docusaurus-plugin-rsdoctor
  • docusaurus-bundler, docusaurus-faster, docusaurus-theme-classic, docusaurus
    • #10402 feat(core): Replace Webpack with Rspack - siteConfig.future.experimental_faster.rspackBundler (@slorber)
  • docusaurus-bundler, docusaurus-faster, docusaurus-types, docusaurus
    • #10554 feat(core): faster HTML minimizer - siteConfig.future.experimental_faster.swcHtmlMinimizer (@slorber)
    • #10522 feat(core): faster CSS minimizer - siteConfig.future.experimental_faster.lightningCssMinimizer (@slorber)
  • docusaurus-theme-mermaid
    • #10510 feat(theme-mermaid): support Mermaid 11+ including new types of diagrams (@slorber)
  • docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus
    • #10479 feat(core, mdx-loader): deduplicate MDX compilation - siteConfig.future.experimental_faster.mdxCrossCompilerCache (@slorber)
  • docusaurus-faster, docusaurus-types, docusaurus
    • #10441 feat(core): faster JS minimizer - siteConfig.future.experimental_faster.swcJsMinimizer (@slorber)
  • docusaurus-faster, docusaurus-plugin-content-docs, docusaurus-types, docusaurus
    • #10435 feat(core): faster transpiler option - siteConfig.future.experimental_faster.swcJsLoader (@slorber)

:bug: Bug Fix

  • docusaurus-bundler, docusaurus
  • docusaurus-bundler
  • docusaurus-theme-classic
  • docusaurus-faster
  • docusaurus
    • #10611 fix(core): fix DOCUSAURUS_CURRENT_LOCALE = 'undefined' (@slorber)
    • #10423 fix(core): always use hash for CSS module class names (@slorber)
  • docusaurus-bundler, docusaurus-faster
  • docusaurus-theme-translations
  • docusaurus-mdx-loader
    • #10553 fix(mdx-loader): fix cross-compiler cache randomly loading mdx with client/server envs (@slorber)
  • docusaurus-tsconfig
    • #10547 fix(tsconfig): add @docusaurus/tsconfig target es2022 (@slorber)
  • docusaurus-plugin-content-blog
  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations
  • docusaurus-types, docusaurus

:running_woman: Performance

  • docusaurus-bundler, docusaurus-faster
  • Other
    • #10601 perf(ci): Add CI checks to prevent memory, build-time and build-size regressions (@slorber)
  • docusaurus
    • #10599 fix(core): fix i18n sites SSG memory leak - require.cache (@slorber)
  • docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages
    • #10470 refactor(mdx-loader): re-export metadata module instead of serializing it (@slorber)
    • #10457 refactor(mdx-loader): read metadata from memory (loaded content) instead of fs (@slorber)

:memo: Documentation

:robot: Dependencies

:wrench: Maintenance

  • Other
  • docusaurus-babel, docusaurus-bundler, docusaurus-mdx-loader, docusaurus-plugin-debug, docusaurus-plugin-pwa, docusaurus-plugin-rsdoctor, docusaurus-theme-live-codeblock, docusaurus
  • docusaurus-bundler, docusaurus-faster
  • docusaurus-bundler, docusaurus-logger, docusaurus-types, docusaurus
  • docusaurus
    • #10587 refactor(core): replace serve-handler fork by official deps (@slorber)
    • #10579 refactor(core): remove useless Webpack wait plugin (@slorber)
    • #10485 refactor(core): rewrite Webpack ChunkAssetPlugin with RuntimeModule (@slorber)
    • #10448 refactor(core): Restore null-loader (@slorber)
    • #10442 fix(core): use serve-handler fork to remove annoying punycode warning (@slorber)
    • #10410 refactor(core): remove useless build forceTerminate exit (@slorber)
  • docusaurus-bundler, docusaurus-plugin-pwa, docusaurus-types, docusaurus
  • create-docusaurus
    • #10514 refactor: remove babel.config.js from init templates + website (@slorber)
  • create-docusaurus, docusaurus-babel, docusaurus-bundler, docusaurus-mdx-loader, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-translations, docusaurus-types, docusaurus-utils, docusaurus
    • #10511 refactor: create @docusaurus/bundler and @docusaurus/babel packages (@slorber)
  • create-docusaurus, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-mermaid, docusaurus-utils, docusaurus, eslint-plugin
  • docusaurus-plugin-content-docs, docusaurus-types, docusaurus
    • #10497 refactor(core): prepare codebase for swappable bundler (@slorber)
  • create-docusaurus, docusaurus-utils
    • #10486 chore: upgrade to TS 5.6 + temporarily use skipLibCheck for TS 5.6 (@slorber)
  • create-docusaurus, docusaurus-logger, docusaurus-theme-translations, docusaurus
    • #10480 refactor: move PerfLogger from core to @docusaurus/logger (@slorber)
  • docusaurus-remark-plugin-npm2yarn
  • docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus
    • #10450 refactor(mdx-loader): refactor mdx-loader, expose loader creation utils (@slorber)
  • docusaurus-mdx-loader, docusaurus-utils, docusaurus
  • docusaurus-mdx-loader
    • #10422 refactor(mdx-loader): remove useless usage of mdx loader this.query (@slorber)

Committers: 19

3.5.2 (2024-08-13)

:bug: Bug Fix

  • docusaurus-theme-common
    • #10397 fix(theme-common): restore useContextualSearchFilters public API for retrocompatibility (@slorber)
  • docusaurus
    • #10391 fix(core): always alias React/ReactDOM to site dependency so that importing MDX from anywhere works (@slorber)
  • create-docusaurus, docusaurus-plugin-content-blog
    • #10392 fix(create-docusaurus): Improve init templates blog setup + fix warnings (@slorber)
  • docusaurus-theme-classic
    • #10390 fix(theme): Adjust blog authors line height to show descenders in lowercase letters (g, j, p, q, and y) (@josh-wong)

:nail_care: Polish

  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations

:memo: Documentation

:robot: Dependencies

Committers: 4

3.5.1 (2024-08-09)

:bug: Bug Fix

  • docusaurus-plugin-content-blog, docusaurus-theme-search-algolia
  • docusaurus-theme-search-algolia

Committers: 2

3.5.0 (2024-08-09)

:rocket: New Feature

  • docusaurus-plugin-content-blog
  • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations
  • create-docusaurus, docusaurus-plugin-content-blog
    • #9252 feat(blog): add feed xlst options to render beautiful RSS and Atom feeds (@Xebec19)
  • docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils
  • docusaurus-theme-translations
  • docusaurus-mdx-loader
    • #10335 feat(mdx-loader): wrap mdx content title (# Title) in <header> for concistency (@OzakIOne)
  • create-docusaurus, docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-utils
  • docusaurus-plugin-client-redirects, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-google-tag-manager, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-plugin-vercel-analytics, docusaurus-types, docusaurus
    • #10286 feat(core): allow plugins to self-disable by returning null (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-theme-common
    • #10252 feat(blog): group sidebar items by year (themeConfig.blog.sidebar.groupByYear) (@alicelovescake)
  • docusaurus-plugin-content-blog, docusaurus-utils
  • docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils-validation

:bug: Bug Fix

  • docusaurus-theme-translations
    • #10344 fix(translations): fix wrong Estonian (et) translations and typos (@Gekd)
    • #10360 fix(translations): Fix and Improve Spanish translations (@sergioalmela)
    • #10235 fix(theme-translation): add missing German (de) theme.admonition translations (@franzd1)
  • docusaurus-theme-search-algolia
    • #10342 fix(search): fix algolia search ignore ctrl + F in search input (@mxschmitt)
  • docusaurus-plugin-content-docs
    • #10324 fix(docs): the category.json description attribute should display on generated index pages (@bharateshwq)
    • #10309 fix(theme): docsVersionDropdown navbar item not showing the appropriate version (@OzakIOne)
  • docusaurus
  • docusaurus-theme-classic
    • #10288 fix(theme): fix DocsVersionDropdownNavbarItem version link target (@slorber)
    • #10219 fix(theme): ignored className attribute on lazy loaded TabItem (@lebalz)
  • docusaurus-utils
    • #10240 fix(markdown): mdx-code-block should support intentation (@slorber)

:nail_care: Polish

  • docusaurus-theme-translations
    • #10257 chore(theme-translations): add more Traditional Chinese(zh-Hant) translations (@pjchender)

:memo: Documentation

:robot: Dependencies

:wrench: Maintenance

  • Other
    • #10369 feat(ci): continuous releases for main and PRs with pkg.pr.new (@Aslemammad)
  • docusaurus-theme-classic
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia
    • #10316 refactor(docs): theme-common shouldn't depend on docs content (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-theme-common
    • #10313 refactor(blog): theme-common shouldn't depend on blog content plugins (@slorber)
  • create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, 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-plugin-vercel-analytics, 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, stylelint-copyright
    • #10256 chore: simplify TypeScript configs, use TS 5.5 configDir placeholder (@slorber)

Committers: 25

3.4.0 (2024-05-31)

:rocket: New Feature

  • create-docusaurus, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus-utils
    • #10137 feat(docs, blog): add support for tags.yml, predefined list of tags (@OzakIOne)
  • docusaurus-theme-translations
    • #10151 feat(theme-translations): Added Turkmen (tk) default theme translations (@ilmedova)
    • #10111 feat(theme-translations): Add Bulgarian default theme translations (bg) (@PetarMc1)
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus
    • #9859 feat(core): hash router option - browse site offline (experimental) (@slorber)
  • docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus
    • #10121 feat(core): site storage config options (experimental) (@slorber)

:bug: Bug Fix

  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils
    • #10185 fix(docs, blog): Markdown link resolution does not support hot reload (@slorber)
  • docusaurus-theme-search-algolia
    • #10178 fix(theme): SearchPage should respect contextualSearch: false setting (@ncoughlin)
    • #10164 fix(search): fix algolia search container bug (@slorber)
  • docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils
    • #10168 fix(mdx-loader): resolve Markdown/MDX links with Remark instead of RegExp (@slorber)
  • docusaurus-theme-translations
  • docusaurus
    • #10145 fix(core): fix serve workaround regexp (@slorber)
    • #10142 fix(core): fix docusaurus serve broken for assets when using trailingSlash (@slorber)
    • #10130 fix(core): the broken anchor checker should not be sensitive pathname trailing slashes (@slorber)
  • docusaurus-theme-classic, docusaurus-theme-common
    • #10144 fix(theme): fix announcement bar layout shift due to missing storage key namespace (@slorber)
  • docusaurus-plugin-content-docs, docusaurus
    • #10132 fix(core): configurePostCss() should run after configureWebpack() (@slorber)
  • docusaurus-utils, docusaurus
    • #10131 fix(core): codegen should generate unique route prop filenames (@slorber)
  • docusaurus-theme-classic, docusaurus-theme-translations
    • #10118 fix(theme-translations): fix missing pluralization for label DocCard.categoryDescription.plurals (@slorber)

:memo: Documentation

  • #10176 docs: add community plugin docusaurus-graph (@Arsero)
  • #10173 docs: improve how to use <details> (@tats-u)
  • #10167 docs: suggest using {<...>...</...>} if don't use Markdown in migra… (@tats-u)
  • #10143 docs: recommend users to remove hast-util-is-element in migration to v3 (@tats-u)
  • #10124 docs: v3 prepare your site blog post should point users to the upgrade guide (@homotechsual)

:robot: Dependencies

Committers: 11

3.3.2 (2024-05-03)

:bug: Bug Fix

  • docusaurus-module-type-aliases, docusaurus
    • #10103 fix(core): do not recreate ReactDOM Root, fix React warning on hot reload (@slorber)

Committers: 1

3.3.1 (2024-05-03)

Failed release

3.3.0 (2024-05-03)

:rocket: New Feature

  • docusaurus-plugin-sitemap
  • docusaurus-mdx-loader, docusaurus-types, docusaurus
    • #10064 feat(core): add new site config option siteConfig.markdown.anchors.maintainCase (@iAdramelk)
  • docusaurus
    • #9767 feat(cli): docusaurus deploy should support a --target-dir option (@SandPod)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-types, docusaurus
    • #10042 feat(core): simplify plugin API, support route.props (@slorber)
  • docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common
    • #10032 feat(pages): add LastUpdateAuthor & LastUpdateTime & editUrl (@OzakIOne)

:bug: Bug Fix

  • docusaurus-cssnano-preset, docusaurus-utils, docusaurus
  • docusaurus-theme-classic
    • #10091 fix(theme): <Tabs> props should allow overriding defaults (@gagdiez)
    • #10080 fix(theme): <Admonition> should render properly without heading/icon (@andrmaz)
  • docusaurus
    • #10090 fix(core): docusaurus serve redirects should include the site /baseUrl/ prefix (@slorber)
  • docusaurus-module-type-aliases, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus
  • docusaurus-theme-translations
    • #10070 fix(theme-translations): add missing theme translations for pt-BR (@h3nr1ke)
    • #10051 fix(theme-translations): correct label for tip admonition in italian (@tomsotte)
  • docusaurus-theme-search-algolia
    • #10048 fix(algolia): add insights property on Algolia Theme Config object TS definition (@Virgil993)
  • docusaurus-plugin-content-docs, docusaurus
    • #10054 fix(core): sortRoutes shouldn't have a default baseUrl value, this led to a bug (@slorber)
  • docusaurus-plugin-content-docs
  • docusaurus-utils
    • #10022 fix(utils): getFileCommitDate should support log.showSignature=true (@slorber)

:running_woman: Performance

  • docusaurus
    • #10060 refactor(core): optimize App entrypoint, it should not re-render when navigating (@slorber)

:nail_care: Polish

  • docusaurus-theme-classic
    • #10061 refactor(theme): simplify CSS solution to solve empty search container (@slorber)
  • docusaurus-theme-common

:memo: Documentation

:robot: Dependencies

:wrench: Maintenance

  • create-docusaurus, docusaurus-cssnano-preset, docusaurus-logger, docusaurus-mdx-loader, 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-plugin-vercel-analytics, 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, stylelint-copyright
    • #10065 refactor: extract base TS client config + upgrade TS + refactor TS setup (@slorber)
  • Other
    • #10063 test(e2e): TypeCheck website/starter in min/max range of TS versions (@slorber)
    • #10049 fix(website): fix website manifest.json name "Docusaurus v2" to just "Docusaurus" (@volcanofr)

Committers: 20

3.2.1 (2024-04-04)

:bug: Bug Fix

  • docusaurus

:memo: Documentation

:robot: Dependencies

Committers: 2

3.2.0 (2024-03-29)

:rocket: New Feature

  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-types, docusaurus-utils, docusaurus
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils-validation, docusaurus-utils
  • docusaurus-plugin-debug, docusaurus-types, docusaurus
    • #9931 feat(core): add new plugin allContentLoaded lifecycle (@slorber)
  • docusaurus-theme-translations
  • docusaurus-plugin-content-blog
    • #9886 feat(blog): allow processing blog posts through a processBlogPosts function (@OzakIOne)
    • #9838 feat(blog): add blog pageBasePath plugin option (@ilg-ul)
  • docusaurus
    • #9681 feat(swizzle): ask user preferred language if no language CLI option provided (@yixiaojiu)
  • create-docusaurus, docusaurus-utils
    • #9442 feat(create-docusaurus): ask user for preferred language when no language CLI option provided (@Rafael-Martins)
  • docusaurus-plugin-vercel-analytics
    • #9687 feat(plugin-vercel-analytics): add new vercel analytics plugin (@OzakIOne)
  • docusaurus-mdx-loader
    • #9684 feat(mdx-loader): the table-of-contents should display toc/headings of imported MDX partials (@anatolykopyl)

:bug: Bug Fix

  • docusaurus-mdx-loader
    • #9999 fix(mdx-loader): Ignore contentTitle coming after Markdown thematicBreak (@slorber)
  • docusaurus-theme-search-algolia
    • #9945 fix(a11y): move focus algolia-search focus back to search input on Escape (@mxschmitt)
  • docusaurus-plugin-content-blog
  • docusaurus-theme-classic
    • #9944 fix(theme): improve a11y of DocSidebarItemCategory expand/collapsed button (@mxschmitt)
  • docusaurus-theme-translations
  • docusaurus-utils
    • #9897 fix(mdx-loader): mdx-code-block should support CRLF (@slorber)
  • docusaurus
    • #9878 fix(core): fix default i18n calendar used, infer it from locale if possible (@slorber)
    • #9852 fix(core): ensure core error boundary is able to render theme layout (@slorber)
  • docusaurus-remark-plugin-npm2yarn
    • #9861 fix(remark-npm2yarn): update npm-to-yarn from 2.0.0 to 2.2.1, fix pnpm extra args syntax (@OzakIOne)
  • docusaurus-theme-classic, docusaurus-theme-translations
    • #9851 fix(theme-classic): should use plurals for category items description (@baradusov)

:running_woman: Performance

  • docusaurus-types, docusaurus-utils, docusaurus
    • #9975 refactor(core): improve dev perf, fine-grained site reloads - part 3 (@slorber)
  • docusaurus-types, docusaurus
    • #9968 refactor(core): improve dev perf, fine-grained site reloads - part2 (@slorber)
  • docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus
    • #9903 refactor(core): improve dev perf, fine-grained site reloads - part1 (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils
    • #9890 perf: optimize getFileCommitDate, make it async (@slorber)
  • docusaurus
    • #9798 refactor(core): internalize, simplify and optimize the SSG logic (@slorber)

:nail_care: Polish

  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common
    • #9868 refactor(theme): dates should be formatted on the client-side instead of in nodejs code (@OzakIOne)
  • docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types
    • #9669 refactor(theme): use JSON-LD instead of microdata for blog structured data (@johnnyreilly)
  • docusaurus-plugin-content-docs
    • #9839 refactor(blog): improve doc global data hook error message + add doc warning to blogOnly mode (@OzakIOne)

:memo: Documentation

:robot: Dependencies

:wrench: Maintenance

  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-docs, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus
  • Other
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils
    • #9963 refactor(docs,blog): last update timestamp should be in milliseconds instead of seconds (@slorber)

Committers: 22

3.1.1 (2024-01-26)

:bug: Bug Fix

  • docusaurus-types, docusaurus
    • #9791 fix(core): broken links optimization behaves differently than non-optimized logic (@slorber)
  • docusaurus
    • #9788 fix(core): links with target "_blank" should no be checked by the broken link checker (@slorber)
    • #9407 fix(core): conditionally include hostname parameter when using… (@jack-robson)
  • docusaurus-utils
    • #9776 fix(mdx-loader): allow spaces before mdx-code-block info string (@eitsupi)
  • create-docusaurus
    • #9783 fix(create-docusaurus): fix typo in init template sample docs (@dawei-wang)
  • docusaurus-theme-common
    • #9727 fix(theme-common): fix missing code block MagicComments style in Visual Basic (.NET) 16 (@tats-u)
  • docusaurus-theme-classic, docusaurus-theme-mermaid
  • docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus

:running_woman: Performance

  • docusaurus

:nail_care: Polish

  • docusaurus-theme-classic

Committers: 6

3.1.0 (2024-01-05)

:rocket: New Feature

  • docusaurus-mdx-loader, docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-types, docusaurus-utils, docusaurus
    • #9528 feat(core): make broken link checker detect broken anchors - add onBrokenAnchors config (@OzakIOne)
  • docusaurus-mdx-loader, docusaurus-types, docusaurus
    • #9674 feat(mdx-loader): add support for siteConfig.markdown.remarkRehypeOptions (@slorber)
  • docusaurus-theme-common
    • #9671 feat(theme-common): code block MagicComments support for (Visual) Basic/Batch/Fortran/COBOL/ML (@tats-u)
  • docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus-utils, docusaurus
    • #9624 feat: siteConfig.markdown.parseFrontMatter hook (@slorber)
  • docusaurus-utils
    • #9610 feat(core): enable port configuration via environment variable (@OzakIOne)

:bug: Bug Fix

  • docusaurus-theme-classic, docusaurus-theme-live-codeblock
    • #9704 fix(theme): allow empty code blocks and live playgrounds (@slorber)
  • create-docusaurus
    • #9696 fix(create-docusaurus): fix init template code blocks, and little improvements (@slorber)
  • docusaurus-plugin-pwa
  • docusaurus
    • #9648 fix(cli): output help when no conventional config + no subcommand (@Josh-Cena)
  • docusaurus-theme-live-codeblock
    • #9631 fix(live-codeblock): stabilize react-live transformCode callback, fix editor/preview desync (@slorber)
  • docusaurus-utils
    • #9617 fix(utils): Markdown link replacement with <> but no spaces (@Josh-Cena)
  • docusaurus-module-type-aliases
    • #9612 fix(type-aliases): add title prop for imported inline SVG React components (@axmmisaka)
  • docusaurus-plugin-content-blog
    • #9581 fix(content-blog): add baseUrl for author.image_url (@OzakIOne)
  • docusaurus-theme-translations
    • #9477 fix(i18n): complete translations for theme-common.json Brazilian Portuguese (pt-BR) (@c0h1b4)

:nail_care: Polish

  • docusaurus-theme-common
    • #9335 refactor(theme-common): allow optional desktopBreakpoint param in useWindowSize (@jgarrow)

:wrench: Maintenance

  • docusaurus-theme-search-algolia

Committers: 8

3.0.1 (2023-11-30)

:bug: Bug Fix

  • docusaurus-utils
    • #9570 fix: add v2 retrocompatible support for quoted admonitions (@slorber)
    • #9535 fix: v3 admonitions should support v2 title syntax for nested admonitions (@slorber)
  • create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
    • #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
  • docusaurus-theme-common
    • #9531 fix(theme): docs html sidebar items should always be visible (@slorber)
  • docusaurus-theme-classic
    • #9530 fix(theme): fix firefox CSS :has() support bug (@slorber)
  • create-docusaurus
    • #9487 fix(create-docusaurus): fix readme docusaurus 2 ref (@slorber)

:robot: Dependencies

  • docusaurus-plugin-debug
    • #9566 chore(debug-plugin): migrate to a new maintained JSON Viewer (@mcrstudio)
  • create-docusaurus, docusaurus-theme-classic, docusaurus-theme-common
    • #9572 chore: upgrade prism-react-renderer to 2.3.0 to avoid older clsx (@harryzcy)
    • #9567 fix(theme): upgrade prism-react-renderer, fix html script and style tag highlighting (@slorber)
  • create-docusaurus, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia
  • docusaurus
  • docusaurus-plugin-pwa, docusaurus

Committers: 6

3.0.0 (2023-10-31)

:boom: 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)

:rocket: 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
    • #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
  • 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: 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
  • create-docusaurus
    • #9217 fix(create-docusaurus): increase Browserslist support query in dev (@slorber)
  • 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)

:running_woman: 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)

:nail_care: 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)

:memo: Documentation

:robot: 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

:wrench: 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: 132