Docusaurus 2 Changelog

2.0.0-alpha.58

🚀 New Feature

docusaurus-plugin-content-docs, docusaurus-theme-classic
- #2916 feat(v2): add a banner that links to latest version of documentation (@teikjun)
- #2682 feat(v2): expanded sidebar categories by default (@jsjoeio)
docusaurus-plugin-debug, docusaurus-preset-classic
- #2928 feat(v2): Implement proof-of-concept Docusaurus Debug Dashboard (@SamChou19815)
docusaurus-init, docusaurus
- #2903 feat(v2): Allow configuring babel via babel.config.js (@SamChou19815)
docusaurus-plugin-client-redirects, docusaurus-utils
- #2793 feat(v2): docusaurus-plugin-client-redirects (@slorber)
docusaurus-theme-live-codeblock
- #2826 feat(v2): allow adding components to react-live scope (@slorber)
docusaurus-theme-classic, docusaurus
- #2856 feat(v2): allow specifying meta image for blog posts (@lex111)
docusaurus-theme-classic
- #2841 feat(v2): Allow swizzling prism-include-languages in theme-classic (@SamChou19815)

💥 Breaking Change

docusaurus-init, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus
- #2895 chore(v2): replace classnames with clsx (@lex111)
docusaurus-plugin-content-docs
- #2861 fix(v2): do not create route for document that serve as docs home page (@lex111)
docusaurus-plugin-content-docs, docusaurus-theme-classic
- #2682 feat(v2): expanded sidebar categories by default (@jsjoeio)

🐛 Bug Fix

docusaurus-plugin-content-docs, docusaurus-theme-bootstrap, docusaurus-theme-classic
- #2905 fix(v2): fix docs homepage permalink issues (@slorber)
docusaurus-theme-classic
- #2932 fix(v2): Add hooks to detect window resize, toggle off sidebar and navbar in desktop (@guillaumejacquart)
- #2909 fix(v2): adjust anchor offset when routes switched (@lex111)
- #2896 fix(v2): set correct canonical url for docs home page (@lex111)
- #2893 fix(v2): Do not automatically change tab when a non-existing option is selected (@SamChou19815)
- #2888 fix(v2): restore styles for menu scrollbar (@lex111)
- #2857 fix(v2): treat inline code in raw HTML as native element (@lex111)
docusaurus
- #2951 fix(v2): Add optional-chaining and nullish-coalescing babel plugin (@SamChou19815)
- #2921 fix(v2): upgrade react-loadable-ssr-addon (@slorber)
- #2854 fix(v2): fix broken build when swizzled NotFound component exist (@lex111)
- #2829 fix(v2): Fix plugin path resolution (@SamChou19815)
docusaurus-preset-classic
- #2944 fix(v2): Declare @docusaurus-plugin-debug as dependency of preset classic (@SamChou19815)
docusaurus-init
- #2902 feat(v2): add nojekyll file to static folder for all templates (@teikjun)
docusaurus-theme-bootstrap
- #2860 fix(v2): bootstrap doc sidebar (@fanny)
Other
- #2874 fix(v2): Getting Started URL (@fanny)
docusaurus-plugin-content-docs
- #2861 fix(v2): do not create route for document that serve as docs home page (@lex111)
docusaurus-plugin-content-docs, docusaurus-theme-classic
- #2867 fix(v2): fix FOUC in doc sidebar and various improvements (@slorber)
docusaurus-theme-search-algolia
- #2838 fix(v2): use base url to navigate to search page (@tetunori)
docusaurus-utils
- #2855 fix(v2): strip images and footnotes for excerpt correctly (@lex111)
docusaurus-theme-live-codeblock
- #2835 fix(v2): set proper font for live editor (@lex111)

💅 Polish

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils, docusaurus
- #2884 polish(v2): improve Docusaurus 1 to 2 migration developer experience (@slorber)
docusaurus-theme-classic
- #2870 refactor(v2): combine nested theme providers into one (@lex111)
- #2880 fix(v2): render as regular text uncollapsible categories (@lex111)
- #2864 refactor(v2): add aria role for doc sidebar (@lex111)
- #2859 refactor(v2): add aria label to paginators (@lex111)
- #2858 refactor(v2): add missing main landmark for needed pages (@lex111)
Other
- #2862 Updated banner in solidarity (@JoelMarcey)

📝 Documentation

#2946 docs(v2): add require.resolve to plugin imports on remaining pages (@teikjun)
#2941 docs(v2): wrap all plugin imports in require.resolve() (@TomBrien)
#2934 docs(v2): add useThemeContext note (@Drewbi)
#2935 docs(v2): Add router implementation note (@Drewbi)
#2933 docs(v2): add documentation for multiple blogs (@teikjun)
#2910 docs(v2): fix GitHub action workflow in docs (@anshulrgoyal)
#2886 docs(v2): fix typo in command on installation page (@pglezen)
#2887 docs(v2): make .nojekyll warning more obvious (@yangshun)
#2865 docs(v2): description field in frontmatter of blog post (@lex111)
#2839 docs(v2): _index docs page does not show a sidebar (@aeneasr)
#2852 misc: move runme demo in block quote about v2 (@lex111)
#2842 docs(v2): Update ZEIT to Vercel (@Nishikoh)

🏠 Internal

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
- #2948 refactor(v2): legacy export = syntax (@slorber)
docusaurus-init, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-utils, docusaurus
- #2922 misc(v2): better dx: yarn clear, yarn watch, yarn serve (@slorber)
Other
- #2929 chore(v2): Run E2E tests in CI (@SamChou19815)
- #2899 chore(deps): bump websocket-extensions from 0.1.3 to 0.1.4 (@dependabot[bot])
- #2897 refactor(v2): synchronize yarn/npm command on site (@lex111)
docusaurus-theme-bootstrap
- #2931 chore(v2): remove unused hooks from bootstrap theme (@fanny)
docusaurus-1.x, docusaurus-plugin-content-docs
- #2906 chore(v2): fix async tests (@slorber)
docusaurus-theme-classic
- #2858 refactor(v2): add missing main landmark for needed pages (@lex111)

🏃‍♀️ Performance

docusaurus-plugin-content-blog, docusaurus-plugin-sitemap
- #2936 perf(v2): convert synchronous filewrite to asynchronous (@moonrailgun)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2900 chore(v2): replace Clipboard with copy-text-to-clipboard (@lex111)
docusaurus-init, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus
- #2895 chore(v2): replace classnames with clsx (@lex111)

Committers: 18

Alexey Pyltsyn (@lex111)
Anshul Goyal (@anshulrgoyal)
Drew Alexander (@Drewbi)
Fanny (@fanny)
Guillaume Jacquart (@guillaumejacquart)
Joe Previte (@jsjoeio)
Joel Marcey (@JoelMarcey)
Koki Nishihara (@Nishikoh)
Paul Glezen (@pglezen)
Sam Zhou (@SamChou19815)
Sébastien Lorber (@slorber)
Teik Jun (@teikjun)
Tom Brien (@TomBrien)
Yangshun Tay (@yangshun)
@belokonm
hackerman (@aeneasr)
moonrailgun (@moonrailgun)
tetunori (@tetunori)

2.0.0-alpha.57

Bad release, check ## 2.0.0-alpha.58

2.0.0-alpha.56

💥 Breaking Change

If you refer to modules (plugins) in your config file in a string form, you will need to replace them with require.resolve calls, for example:

- plugins: ['@docusaurus/plugin-google-analytics']
+ plugins: [require.resolve('@docusaurus/plugin-google-analytics')]

docusaurus-theme-classic
- #2818 feat(v2): automatically add base url to logo link (@lex111)
docusaurus-theme-classic, docusaurus-theme-search-algolia
- #2791 refactor(v2): show search icon only on mobiles (@lex111)
docusaurus
- #2780 feat(v2): open external links in new tab by default (@jknoxville)

🚀 New Feature

docusaurus-types, docusaurus
- #2770 feat(v2): allow deploy without building website (@lex111)
docusaurus-theme-classic
- #2818 feat(v2): automatically add base url to logo link (@lex111)

🐛 Bug Fix

docusaurus-theme-classic
- #2645 fix(v2): enable scrolling for sidebar menu only (@lex111)
- #2800 fix(v2): make proper h1 font size on mobiles (@lex111)
docusaurus
- #2788 fix(v2): use require.resolve for all webpack presets and plugins (@SamChou19815)
docusaurus-plugin-content-docs
- #2785 fix(v2): do not show sidebar on reserved docs home page (@lex111)
- #2777 fix(v2): check for docs homepage correctly (@lex111)

💅 Polish

docusaurus-theme-classic
- #2820 chore(v2): upgrade Infima to 0.2.0-alpha.12 (@lex111)
docusaurus-theme-search-algolia
- #2814 refactor(v2): align search icon to center on mobiles (@lex111)
- #2799 refactor(v2): increase search input on medium screens (@lex111)
docusaurus-init
- #2802 misc: minor improvements for init templates (@lex111)
docusaurus-theme-classic, docusaurus-theme-search-algolia
- #2791 refactor(v2): show search icon only on mobiles (@lex111)
docusaurus
- #2783 refactor(v2): make external links more secure (@lex111)

📝 Documentation

#2809 docs(v2): add mention on DocSearch when you run the crawler on your own (@s-pace)

🏠 Internal

#2778 fix(v2): do not highlight root docs path in navbar (@lex111)

Committers: 8

Alexey Pyltsyn (@lex111)
James McShane (@jmcshane)
John Knox (@jknoxville)
Kasper Bøgebjerg Pedersen (@kasperp)
Muhammad Ali (@mrmuhammadali)
Piotr Baran (@piotros)
Sam Zhou (@SamChou19815)
Sylvain Pace (@s-pace)

2.0.0-alpha.55

💥 Breaking Change

infima
- The following Infima classes have been renamed for consistency:
  - page-item → pagination__item
  - pagination-nav__link--label → pagination-nav__label
  - pagination-nav__link--sublabel → pagination-nav__sublabel
  - tab-item → tabs__item
  - tab-item--active → tabs__item--active
  If you have swizzled components, you need to replace these class names.
docusaurus
- #2764 feat(v2): allow import SVG images (@lex111)

🚀 New Feature

docusaurus
- #2764 feat(v2): allow import SVG images (@lex111)
docusaurus-theme-classic
- #2690 feat(v2): allow activeBaseTest in NavLink (@nebrelbug)
- #2694 feat(v2): add canonical URL to <head> (@jcomack)
docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-types, docusaurus
- #2652 feat(v2): allow home page for docs (@lex111)
docusaurus-plugin-content-docs, docusaurus-theme-search-algolia, docusaurus
- #2756 feat(v2): add search page 🔎 (@lex111)

🐛 Bug Fix

docusaurus-plugin-content-docs, docusaurus-utils
- #2701 fix(v2): remove Markdown syntax from excerpt (@lex111)
docusaurus-theme-classic
- #2765 fix(v2): remove invalid attr from mobile nav links (@lex111)
- #2760 fix(v2): move anchor link to right of heading (@lex111)
- #2758 fix(v2): remove extra top margin of tab item (@lex111)
- #2759 fix(v2): restore hiding of docs toc (@lex111)
docusaurus-theme-search-algolia
- #2762 fix(v2): avoid duplication search input in navbar (@lex111)
lqip-loader
- #2693 fix(v2): add support esModule to lqip-loader (@ykzts)
docusaurus-init
- #2751 fix(v2): fix index page features.length when 0 (@jdeniau)

💅 Polish

docusaurus-theme-classic
- #2773 chore(v2): upgrade Infima to 0.2.0-alpha.11 (@lex111)
- #2766 refactor(v2): remove extra active CSS class for menu item links (@lex111)
docusaurus-theme-live-codeblock
- #2767 refactor(v2): add support for dark mode to live code blocks (@lex111)
docusaurus-theme-search-algolia
- #2761 refactor(v2): improve UX of search page (@lex111)
docusaurus-theme-bootstrap, docusaurus-theme-classic
- #2729 chore(v2): upgrade Infima to 0.2.0-alpha.10 (@lex111)
docusaurus-utils
- #2696 refactor(v2): make semicolon optional in imports for excerpt (@lex111)

📝 Documentation

#2768 docs(v2): various improvements (@lex111)
#2670 docs(v2): add deployment workflow manual for GitHub Actions (@artemkovalyov)

🏠 Internal

docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus
- #2464 refactor(v2): add @theme-init alias to give access to initial components (@lex111)

🏃‍♀️ Performance

docusaurus
- #2684 refactor(v2): replace EJS with Eta for SSR generation (@nebrelbug)

Committers: 13

Alexey Pyltsyn (@lex111)
Artem Kovalov (@artemkovalyov)
Ben Gubler (@nebrelbug)
Fanny (@fanny)
Jimmy (@jcomack)
Jonny Nabors (@jonnynabors)
Julien Deniau (@jdeniau)
Marco Moretti (@marcosvega91)
Rajiv Singh (@iamrajiv)
Sébastien Lorber (@slorber)
Taylor Reece (@taylorreece)
Yamagishi Kazutoshi (@ykzts)
Yangshun Tay (@yangshun)

2.0.0-alpha.54

HOTFIX for 2.0.0-alpha.53.

🐛 Bug Fix

docusaurus-theme-classic
- #2688 fix(v2): add default value for options in theme classic (@lex111)
docusaurus-module-type-aliases
- #2687 fix(v2): Add all webpack module aliases to type declaration file (@SamChou19815)

📝 Documentation

#2680 docs(v2): add swizzle example (@jsjoeio)

Committers: 3

Alexey Pyltsyn (@lex111)
Joe Previte (@jsjoeio)
Sam Zhou (@SamChou19815)

2.0.0-alpha.53

HOTFIX for 2.0.0-alpha.51.

🐛 Bug Fix

docusaurus-theme-classic
- #2676 fix(v2): allow build website without custom css (@lex111)

Committers: 1

Alexey Pyltsyn (@lex111)

2.0.0-alpha.51

💥 Breaking Change

infima
- The following infima variables have been renamed for consistency:
  - --ifm-font-base-color → --ifm-font-color-base
  - --ifm-font-base-color-inverse → --ifm-font-color-base-inverse
  - --ifm-font-color-secondary → --ifm-font-color-secondary

🚀 New Feature

docusaurus-theme-classic
- #2660 feat(v2): add ability to specify CSS class for navbar item (@lex111)
- #2597 feat(v2): add ability set dark mode by default (@lex111)
docusaurus
- #2665 feat(v2): add fallback to BrowserOnly component (@lex111)
docusaurus-types, docusaurus
- #2630 feat(v2): add CLI option for polling (@TomBrien)
docusaurus-init
- #2541 feat(v2): add showReadingTime and editUrl to the templates (@fanny)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils
- #2524 feat(v2): add edit url in post page (@fanny)
docusaurus-plugin-content-blog, docusaurus-theme-classic
- #2531 feat(v2): add blog post estimated reading time (@JoseRenan)

🐛 Bug Fix

docusaurus-theme-classic
- #2672 fix(v2): add a11y support for dropdown (@lex111)
- #2649 fix(v2): hide sidebar after click on child item (@lex111)
- #2631 fix(v2): hide doc sidebar on mobiles (@lex111)
- #2626 fix(v2): make border right of doc sidebar equals doc page (@lex111)
- #2625 fix(v2): disable tab focus on collapsed doc sidebar items (@lex111)
- #2602 fix(v2): inherit color for announcement bar close icon (@lex111)
- #2582 fix(v2): remove horizontal scroll on docs page (@lex111)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2666 chore(v2): upgrade prism-react-renderer to latest version (@lex111)
- #2533 fix(v2): add rounded corners in code blocks properly (@lex111)
docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, docusaurus-plugin-content-docs, docusaurus
- #2661 chore: upgrade shelljs to 0.8.4 (@lex111)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-preset-classic, docusaurus-theme-classic
- #2642 fix(v2): use remark-admonitions separately in each plugin instead of in preset only (@lex111)
docusaurus-utils
- #2380 fix(v2): ignore import declarations in excerpt (@lex111)
docusaurus-plugin-sitemap
- #2616 fix(v2): don't include 404 page in sitemaps (@RDIL)
- #2530 fix(v2): Use writeFileSync to write generated sitemap.xml to avoid early termination (@SamChou19815)
docusaurus
- #2558 fix(v2): properly link top-level github pages sites in deploy command (@RDIL)
- #2580 fix(v2): do not process anchor links by router (@lex111)
- #2579 fix(v2): treat mailto and tel links properly (@lex111)
docusaurus-plugin-content-blog
- #2540 fix(v2): use synchronous write for generate blog feeds (@lex111)

💅 Polish

docusaurus-theme-classic
- #2656 refactor(v2): lose focus of active sidebar item after click on it (@lex111)
- #2627 refactor(v2): extract scroll position detection into separate hook (@lex111)
- #2595 refactor(v2): make margin top on blog pages as on other pages (@lex111)
- #2588 refactor(v2): remove redundant container on docs page (@lex111)
docusaurus-theme-classic, docusaurus
- #2585 refactor(v2): use nav link component only where needed (@lex111)
docusaurus
- #2556 refactor(v2): enhance CLI experience (@RDIL)
- #2529 refactor(v2): replace few Lodash methods with native counterparts (@Simek)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2534 refactor(v2): make better code blocks (@lex111)
- #2526 fix(v2): make code block nicer again (@yangshun)
docusaurus-plugin-content-docs
- #2519 chore(v2): use single method Lodash packages in docs plugin (@Simek)

📝 Documentation

#2659 fix(docs): mention that appID is optional (@s-pace)
#2596 docs(v2): remove duplicated package.json in installation directory structure (@jaylees14)
#2572 docs(v2): mention that plugin-ideal-image only perform compression on a production build (@Noah-Silvera)
#2570 docs(v2): fix syntax error for @docusaurus/plugin-ideal-image example (@Noah-Silvera)
#2566 docs(v2): be more polite (@lex111)
#2559 doc(v2): remove legacy blog metadata (@RDIL)
#2549 docs(v2): command for swizzling all components (@fanny)
#2547 docs(v2): Fix typo in team page (@SamChou19815)
#2545 docs(v2): add community pages (@yangshun)
#2521 docs(v2): useThemeContext hook (@lex111)

🏠 Internal

docusaurus-types, docusaurus
- #2578 refactor(v2): Convert docusaurus-core to TypeScript (@SamChou19815)
Other
- #2569 docs(v2): showcase user Tourmaline (@watzon)
- #2553 misc(v2): remove deprecated/useless lerna field (@slorber)
docusaurus-1.x, lqip-loader
- #2563 chore(v2): fix lint, tweak lqip-loader utils comment (@Simek)
lqip-loader
- #2561 chore(v2): add lqip-loader tests, clarify loader code, improve README (@Simek)
docusaurus-plugin-ideal-image, lqip-loader
- #2544 refactor(v2): import lqip-loader to monorepo, fix build on Node 13, fix lint-staged (@Simek)
docusaurus-init
- #2542 chore(v2): update Prettier config (@lex111)
docusaurus-1.x, docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, stylelint-copyright
- #2538 chore(v2): upgrade devDependencies (@yangshun)
docusaurus-utils
- #2536 refactor(v2): replace Lodash with single methods packages in utils (@Simek)
docusaurus
- #2535 refactor(v2): replace Lodash with single methods packages in core (@Simek)

Committers: 18

Alexey Pyltsyn (@lex111)
Anayo Oleru (@AnayoOleru)
Bartosz Kaszubowski (@Simek)
Chris Watson (@watzon)
Fanny (@fanny)
Jay Lees (@jaylees14)
Joe Previte (@jsjoeio)
José Renan (@JoseRenan)
Kamil Kisiela (@kamilkisiela)
Kristóf Poduszló (@kripod)
Mehmet Yatkı (@yatki)
Noah Silvera (@Noah-Silvera)
Reece Dunham (@RDIL)
Sam Zhou (@SamChou19815)
Sylvain Pace (@s-pace)
Sébastien Lorber (@slorber)
Tom Brien (@TomBrien)
Yangshun Tay (@yangshun)

2.0.0-alpha.50 (2020-04-02)

HOTFIX for 2.0.0-alpha.49.

🐛 Bug Fix

docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2509 fix(v2): synchronize code block components changes (@lex111)
docusaurus-theme-classic
- #2498 fix(v2): blog item styling (@yangshun)
- #2489 fix(v2): fix HTML issues nav dropdown and highlight docs item (@lex111)
docusaurus
- #2496 fix(v2): do not force terminate building when running deploy command (@lex111)
docusaurus-utils
- #2497 fix(v2): unbreak blog-only mode routing by deplicating starting forward slashes (@SamChou19815)

💅 Polish

docusaurus-theme-classic
- #2505 fix(v2): tweak colors for announcement bar (@yangshun)
- #2504 refactor(v2): improve announcement bar (@lex111)
- #2495 refactor(v2): update HTML markup of pagination for better a11y (@lex111)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2502 fix(v2): make code block nicer (@yangshun)
docusaurus-plugin-content-docs, docusaurus
- #2490 fix(v2): use lodash instead of array-map-polyfill (@lex111)

📝 Documentation

docusaurus-theme-classic
- #2500 docs(v2): misc docs updates (@yangshun)

🏠 Internal

#2486 misc: add instructions about test release (@lex111)

Committers: 5

Alexey Pyltsyn (@lex111)
Can Gencer (@cangencer)
Richard Chan (@iWun)
Sam Zhou (@SamChou19815)
Yangshun Tay (@yangshun)

2.0.0-alpha.49 (2020-04-01)

🚀 New Feature

docusaurus-theme-classic
- #2487 feat(v2): nav dropdown (@yangshun)
- #2456 feat(v2): support comments for code highlighting (@elviswolcott)
- #2330 feat(v2): add announcement bar (@lex111)
- #2440 feat(v2): make clickable sidebar logo (@lex111)
- #2366 feat(v2): support syncing tab choices (@SamChou19815)
docusaurus
- #2323 feat(v2): add a way to exclude components from build-time prerendering (@lex111)
- #2469 feat(v2): add TypeScript support for theme components (@SamChou19815)
- #2455 feat(v2): add @theme-original alias to give access to pre-swizzled components (@yangshun)
- #2438 feat(v2): add version to page's generated meta tags (@lex111)
docusaurus-types, docusaurus
- #2474 feat(v2): add ability to create unminimized bundles (@lex111)
- #2417 feat(v2): allow custom output directory for build (@ZachJW34)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2346 feat(v2): add filename in CodeBlock (@KohheePeace)
docusaurus-plugin-content-docs, docusaurus
- #2444 feat(v2): allow nested sidebar category shorthand syntax (@slorber)

🐛 Bug Fix

docusaurus-theme-classic
- #2483 fix(v2): do not render sidebar logo if used sticky navbar (@lex111)
- #2475 fix(v2): make correct Open Graph title for doc page (@lex111)
- #2436 fix(v2): update twitter:card to summary_large_image (@lex111)
- #2434 fix(v2): add support dark logo for sidebar logo (@lex111)
- #2420 fix(v2): fix external URL for og:image tag (@38elements)
docusaurus-theme-live-codeblock
- #2480 fix(v2): various improvements for accessibility (@lex111)
docusaurus-mdx-loader, docusaurus-theme-classic
- #2479 chore(v2): upgrade MDX to 1.5.8 (@lex111)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2476 fix(v2): improve code block scroll accessibility (@lex111)
- #2442 fix(v2): various improvements for accessibility (@lex111)
docusaurus-preset-classic, docusaurus-theme-classic
- #2477 chore(v2): upgrade remark-admonitions for a11y fixes (@lex111)
docusaurus
- #2462 fix(v2): do not force terminate building when bundle analyzer is on (@lex111)
- #2393 fix(v2): normalize location for route matching (@rlamana)
- #2443 fix(v2): always exit after successful build (@mohrash92)
- #2437 fix(v2): do not force terminate building if client bundle failed in development mode (@lex111)
- #2424 fix(v2): make correct internal link check (@lex111)
docusaurus-preset-classic
- #2451 fix(v2): pass options to remark-admonitions (@elviswolcott)
docusaurus-mdx-loader
- #2426 fix(v2): remove HTML from heading slug (@lex111)
docusaurus-utils
- #2405 fix(v2): properly dedupe forward slashes in the entire URL path (@rlamana)

💅 Polish

docusaurus-theme-classic
- #2485 refactor(v2): remove unnecessary X-UA-Compatible meta tag (@lex111)
docusaurus-plugin-content-blog
- #2460 refactor(v2): use single method package instead of whole Lodash package in blog plugin (@Simek)
Other
- #2428 polish(v2): use npm-to-yarn for the npm2yarn remark plugin (@nebrelbug)

📝 Documentation

Other
- #2478 docs(v2): mark that in dev server some features may not work (@lex111)
- #2472 docs(v2): fix typo in deployment docs (@GermaVinsmoke)
- #2423 docs(v2): add Sass/SCSS under the styling section (@rlamana)
- #2446 docs(v2): add docusaurus-plugin-sass to community plugins (@rlamana)
- #2408 docs(v2): suggest Surge for quick deployment (@fakela)
- #2401 docs(v2): add resources page (@yangshun)
- #2413 docs(v2): include appId key for Algolia (@TheodoreChu)
- #2411 docs:(v2): add Netlify configuration warning (@bravo-kernel)
- #2397 docs(v2):update alpha version to current version (@fakela)
- #2395 docs(v2): clarify instructions on docs-only mode (@phoqe)
docusaurus-init
- #2458 fix(v2): expand broken admonitions (@elviswolcott)

🏠 Internal

docusaurus
- #2461 chore(v2): upgrade react-dev-utils (@lex111)
Other
- #2450 docs(v2): Adding Motion Layout to Docusaurus users (@jeffersonlicet)
- #2450 docs(v2): Adding Motion Layout to Docusaurus users (@jeffersonlicet)
- #2439 polish(v2): add logo for dark mode (@lex111)
- #2435 fix(v2): fix aspect ratio for Open Graph image (@lex111)
- #2433 chore(v2): ignore JetBrains editors .iml files (@slorber)
- #2416 docs(v2): Add Build Tracker to Showcase page (@paularmstrong)
- #2388 docs(v1): showcase user Day.js (@iamkun)
stylelint-copyright
- #2415 misc: improve stylelint rule (@ayshiff)

Committers: 24

Alexey Pyltsyn (@lex111)
Bartosz Kaszubowski (@Simek)
Ben Gubler (@nebrelbug)
Elvis Wolcott (@elviswolcott)
Fanny (@fanny)
Favour Kelvin (@fakela)
Jefferson Licet (@jeffersonlicet)
Kohhee Peace (@KohheePeace)
Linus Långberg (@phoqe)
Luke Collier (@lukecollier)
Nisar Hassan Naqvi (@nisarhassan12)
Paul Armstrong (@paularmstrong)
Ramón Lamana (@rlamana)
Rémi Doreau (@ayshiff)
Sam Zhou (@SamChou19815)
Sébastien Lorber (@slorber)
Theodore Chu (@TheodoreChu)
Yangshun Tay (@yangshun)
@38elements
@GermaVinsmoke
@ZachJW34
@bravo-kernel
@iamkun
@mohrash92

2.0.0-alpha.48 (2020-03-08)

HOTFIX for 2.0.0-alpha.44.

🐛 Bug Fix

Other
- #2383 fix(v2): specify proper version for stylelint-copyright (@lex111)
docusaurus
- #2382 fix(v2): add missing preset-typescript dependency (@lex111)
docusaurus-theme-classic
- #2386 fix(v2): add missing prismjs dependency and Noop component (@lex111)

Committers: 1

Alexey Pyltsyn (@lex111)

2.0.0-alpha.44 (2020-03-08)

🚀 New Feature

docusaurus-theme-classic
- #2250 feat(v2): add support specify new languages for Prism (@lex111)
- #2344 feat(v2): allow specifying custom target for logo link (@lex111)
- #2327 feat(v2): add ability to use HTML in footer copyright (@lex111)
docusaurus-plugin-content-blog
- #2335 feat(v2): add draft feature to blog posts (@lex111)
docusaurus-init, docusaurus-theme-classic
- #2303 docs(v2): Nav links activeBasePath (@yangshun)
docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus
- #2296 feat(v2): add ExecutionEnvironment API (@yangshun)

🐛 Bug Fix

docusaurus
- #2345 fix(v2): force terminate building if client bundle failed (@lex111)
- #2310 fix(v2): add @babel/preset-typescript to babel-loader (@deniaz)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2371 fix(v2): remove line break from end of code blocks (@lex111)
docusaurus-plugin-content-blog
- #2326 fix(v2): linkify blog posts (@lex111)
docusaurus-theme-classic
- #2324 fix(v2): properly set dark mode logo on build-time prerendering (@lex111)
- #2325 fix(v2): switch a toggle when system theme changed (@lex111)
docusaurus-plugin-content-pages, docusaurus-utils
- #2334 fix(v2): make proper path to pages in TS (@lex111)
Other
- #2316 fix(v2): properly scale logo on IE 11 (@lex111)

💅 Polish

docusaurus-theme-search-algolia
- #2376 refactor(v2): clean up and improve Algolia styles (@lex111)
docusaurus-theme-classic, docusaurus-theme-search-algolia
- #2372 chore(v2): upgrade Infima and remark-admonitions (@lex111)
docusaurus-theme-classic
- #2367 refactor(v2): increase CSS specificity on application container (@lex111)
docusaurus-init, stylelint-copyright
- #2363 fix(v2): improve stylelint copyright header rule (@yangshun)
docusaurus-types, docusaurus
- #2342 chore(v2): mark tagline field as optional (@lex111)

📝 Documentation

#2378 docs(v2): add section for docs-only mode (@phoqe)
#2357 docs(v2): fix getPathsToWatch() example syntax in lifecycle APIs (@rlamana)
#2351 docs(v2): add examples to plugin usage doc (@Noah-Silvera)
#2343 docs(v2): fix typo in remark-admonitions example (@hassanfarid)
#2340 docs(v2): mention about disabling Jekyll when using GitHub pages (@amilajack)
#2338 docs(v2): guide on upgrading Docusaurus within a project (@TheodoreChu)
#2313 docs(v2): move the quotes to remark admonitions (@Zhencha0Cai)
#2307 docs(v1): fix Windows instructions for GitHub Pages publishing (@jartuso)
#2300 docs(v2): make blog plugin config example valid (@balloob)
#2289 docs(v2): add instructions on Travis CI deployment (@mohamedsgap)

🏠 Internal

Other
- #2369 misc: mention about v2 in README file (@lex111)
- #2368 misc: add note about edits in versioned docs (@lex111)
- #2333 docs: update use of npm/yarn in contributing.md (@jsjoeio)
- #2328 docs(v2): remove unwanted black line from DocSearch showcase image (@s-pace)
- #2319 docs(v2): showcase user Algolia (@scottilee)
docusaurus-init
- #2322 docs(v2): fix misc styling (@lex111)

Committers: 16

Alexey Pyltsyn (@lex111)
Amila Welihinda (@amilajack)
Hassan Farid (@hassanfarid)
Joe Previte (@jsjoeio)
Linus Långberg (@phoqe)
Mohamed Abdel Nasser (@mohamedsgap)
Noah Silvera (@Noah-Silvera)
Paulus Schoutsen (@balloob)
Ramón Lamana (@rlamana)
Robert (@deniaz)
Scott Lee (@scottilee)
Sylvain Pace (@s-pace)
Theodore Chu (@TheodoreChu)
Yangshun Tay (@yangshun)
Zhenchao Cai (@Zhencha0Cai)
@jartuso

2.0.0-alpha.43 (2020-02-18)

HOTFIX for 2.0.0-alpha.41.

🐛 Bug Fix

docusaurus-theme-classic
- #2292 chore(v2): update Infima to 0.2.0-alpha.4 (@yangshun)
- #2291 fix(v2): fix build and deps install (@lex111)

Committers: 2

Alexey Pyltsyn (@lex111)
Yangshun Tay (@yangshun)

2.0.0-alpha.41 (2020-02-16)

🚀 New Feature

docusaurus-init, docusaurus-preset-classic, docusaurus-theme-classic
- #2224 feat(v2): add remark-admonitions to @docusaurus/preset-classic (@elviswolcott)
docusaurus-theme-classic, docusaurus
- #2263 feat(v2): pluralize posts on tag's page (@lex111)
docusaurus-theme-classic
- #2261 feat(v2): allow to specify different logo for dark mode (@lex111)
- #2253 feat(v2): allow specify custom link for logo (@lex111)
- #2255 feat(v2): add site title to meta title (@lex111)
docusaurus-plugin-content-pages, docusaurus-utils, docusaurus
- #2221 feat(v2): allow for Typescript pages and components (@jonathanrdelgado)

💥 Breaking Change

docusaurus-theme-classic
- #2235 fix(v2): show doc sidebar on pages with case-sensitive paths (@lex111)

🐛 Bug Fix

docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2285 fix(v2): fix codeblock copy button not including blank lines (@KohheePeace)
- #2241 fix(v2): make code blocks scrollable (@lex111)
docusaurus-theme-classic
- #2259 fix(v2): use site title if enabled blog-only mode (@lex111)
- #2248 fix(v2): adjust correct behavior of navbar when active anchor (@lex111)
- #2235 fix(v2): show doc sidebar on pages with case-sensitive paths (@lex111)
- #2162 fix(v2): unify anchor behavior (@lex111)
docusaurus-theme-search-algolia
- #2262 fix(v2): remove focus on search input when hovering over it (@lex111)
docusaurus-plugin-content-blog, docusaurus-theme-classic
- #2240 fix(v2): hide read more button on non-truncated posts (@lex111)
docusaurus
- #2237 fix(v2): include base url in 404 route (@lex111)
docusaurus-mdx-loader
- #2236 fix(v2): escape link text in TOC (@lex111)
docusaurus-theme-live-codeblock
- #2227 fix(v2): render correct theme for live code blocks on SSR (@lex111)

💅 Polish

docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2254 refactor(v2): avoid to use raw theme values (@lex111)

📝 Documentation

#2281 docs: update windows deploy command (@OndrejNepozitek)
#2257 docs(v2): require using JSX flavored style objects in mdx (@wgao19)
#2251 docs(v2): collapsible categories in sidebar (@lex111)
#2218 docs(v2): update link to available prism themes (@jsjoeio)
#2216 docs(v2): fix plugin-content-docs config comment typo (@sdowding)

🏠 Internal

Other
- #2256 fix(v2): add title for Feedback page (@lex111)
- #2246 docs(v2): add Benthos to showcase (@Jeffail)
- #2242 docs(v1): showcase user Jafar (@galhavivi)
- #2238 docs(v1): showcase Dime (@hbulens)
- #2233 docs(v2): showcase user supabase (@awalias)
- #2226 docs(v1): showcase user Adapt.js (@mterrel)
- #2225 docs(v1): add The Diff Podcast to users (@JoelMarcey)
- #2219 chore(v1): Updated users list, removing sites not using docusaurus (@jjwill)
docusaurus-theme-classic, docusaurus
- #2239 chore(eslint): require curly brackets on all blocks (@lex111)

Committers: 18

Alexey Pyltsyn (@lex111)
Ashley Jeffs (@Jeffail)
Elie Dutheil (@edwandr)
Elvis Wolcott (@elviswolcott)
Evan Rubinton (@erubi)
Gal Havivi (@galhavivi)
Hanseung Yoo (@trustyoo86)
Hendrik Bulens (@hbulens)
JavaScript Joe (@jsjoeio)
Joel Marcey (@JoelMarcey)
Jonathan Delgado (@jonathanrdelgado)
Joshua Williams (@jjwill)
KohheePeace (@KohheePeace)
Mark Terrel (@mterrel)
Ondřej Nepožitek (@OndrejNepozitek)
Scott Dowding (@sdowding)
Wei Gao (@wgao19)
@awalias

2.0.0-alpha.40 (2019-12-25)

🚀 New Feature

docusaurus-theme-classic
- #2117 feat(v2): auto switch theme depending on the system theme (@lex111)
- #2055 feat(v2): hide navbar on scroll (@lex111)

🐛 Bug Fix

docusaurus
- #2145 fix(v2): remove style-loader, use minicssextract in both dev & prod (@endiliey)
- #2122 fix(v2): dont collapse whitespace in minified html (@endiliey)
docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
- #2105 fix(v2): move metadata export after compiling MDX to avoid weird MDX parsing error. (@endiliey)
docusaurus-theme-classic
- #2113 fix(v2): set stored theme only if it exists (@lex111)

💅 Polish

docusaurus-theme-classic
- #2129 fix(v2): disable scroll while mobile menu open (@lex111)
docusaurus-theme-classic, docusaurus
- #2127 refactor(v2): toggle data-theme with vanilla js instead of react helmet (@endiliey)
docusaurus-theme-search-algolia, docusaurus
- #2125 feat(v2): lazy load algolia css so its not render blocking (@endiliey)

📝 Documentation

Other
- #2135 docs(v1): add space between "out" and "Docusaurus" (@TransmissionsDev)
- #2128 docs(v1): showcase user Shrine (@janko)
- #2110 docs(v2): fix pages routing inaccurate info (@endiliey)
- #2106 fix(v2): add missing hyphen in color generator (@lex111)
- #2104 feat(v2): add color generator for primary colors (@yangshun)
- #2103 docs: mention about moving docs directory into website (@yangshun)
docusaurus-theme-classic, docusaurus-theme-live-codeblock
- #2114 fix(v2): add syntax highlight to generated colors (@lex111)

🏠 Internal

Other
- #2126 docs: promote Docusaurus 2 usage (@yangshun)
- #2119 fix(v2): align GH button in vertical center (@lex111)
docusaurus-init
- #2124 feat(v2): add Facebook Docusaurus 2 template (@yangshun)
docusaurus
- #2111 feat(v2): explicit babel/runtime version (@endiliey)
docusaurus-1.x, docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-theme-live-codeblock, docusaurus
- #2102 misc: add command to run prettier on docs (@yangshun)

🏃‍♀️ Performance

docusaurus
- #2118 perf(v2): reduce HTML payload by eliminating chunk-map (@endiliey)
- #2116 feat(v2): minify html (@endiliey)

Committers: 6

Alexey Pyltsyn (@lex111)
Endi (@endiliey)
Janko Marohnić (@janko)
Nick McCurdy (@nickmccurdy)
Yangshun Tay (@yangshun)
t11s (@TransmissionsDev)

2.0.0-alpha.39

🐛 Bug Fix

docusaurus
- #2099 fix(v2): escape import path on windows (@endiliey)
docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
- #2095 fix(v2): metadata error if markdown does not have ending line (@endiliey)

🏠 Internal

Other
- #2100 chore(CI): docusaurus build on Windows with GitHub actions (@endiliey)
docusaurus
- #2096 feat(v2): better & nice looking error overlay (@endiliey)

Committers: 1

Endi (@endiliey)

2.0.0-alpha.38

💥 Breaking Change

docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-utils
- #2088 perf(v2): smaller bundlesize by embedding metadata to content (@endiliey)

If you have swizzled any Docs/Blog component that depends on metadata, you'll have to update. If you haven't, no action is needed.

For example, if you've swizzled @theme/DocItem. You'll have to update

- const {metadata, content: DocContent} = props;
+ const {content: DocContent} = props;
+ const {metadata} = DocContent;

🐛 Bug Fix

docusaurus
- #2086 fix(v2): windows compatibility regression (@endiliey)
docusaurus-plugin-ideal-image
- #2074 fix(v2): fix plugin-ideal-image breaking website (exports not defined) (@endiliey)

💅 Polish

docusaurus-mdx-loader
- #2085 misc(v2): update mdx loader plugin README (@shivangna)

🏠 Internal

docusaurus-1.x
- #2087 fix(v1): add key to versions.map in versions.js (@FeynmanDNA)
- #2083 refactor(v1): fix props for ProjectTitle (@FeynmanDNA)
docusaurus
- #2081 refactor(v2): move scripts/stylesheets injection to server side (@endiliey)
- #2080 refactor(v2): minor code refactoring on component creator (@endiliey)

🏃‍♀️ Performance

docusaurus-utils
- #2089 perf(v2): improve dev build time by not overwriting file if possible (@endiliey)
docusaurus-theme-search-algolia
- #2079 perf(v2): algolia search result no longer cause full page refresh (@endiliey)
- #2076 perf(v2): load algolia JS only when user interacts with search (@endiliey)

Committers: 4

Endi (@endiliey)
KYY (@FeynmanDNA)
Shivangna Kaistha (@shivangna)
kaichu (@qshiwu)

2.0.0-alpha.37

💥 Breaking Change

docusaurus-init, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus
- #2045 breaking(v2): minimum required nodejs version 8.9-> 8.10 so we can use es2017 (@endiliey)

🚀 New Feature

docusaurus-theme-classic, docusaurus
- #2069 feat(v2): support prefers-color-scheme & fix dark mode FOUC on refresh (@endiliey)
docusaurus-plugin-content-blog
- #2000 feat(v2): add meta RSS/Atom feed links to head (@lex111)
docusaurus-plugin-content-docs, docusaurus-types, docusaurus
- #2057 feat(v2): injectHtmlTags API to inject head and/or body html tags (@endiliey)
docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus
- #2032 feat(v2): allow non sidebar category to be first item of sidebar (@endiliey)
docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-types, docusaurus
- #1983 feat(v2): docs versioning ❄️🔥 (@endiliey)

🐛 Bug Fix

docusaurus-theme-classic, docusaurus
- #2069 feat(v2): support prefers-color-scheme & fix dark mode FOUC on refresh (@endiliey)
docusaurus-mdx-loader
- #2067 fix(v2): toc should not be broken for heading with html inline code (@endiliey)
docusaurus-theme-classic
- #2064 fix(v2): markdown reference to file should not be page not found (@endiliey)
- #2061 fix(v2): fix docs sidebar highlighting if link is partially matched (@endiliey)
docusaurus
- #2042 fix(v2): remove css order warning if css imports are not sorted (@endiliey)

💅 Polish

docusaurus-theme-classic
- #2066 refactor(v2): add title attribute to anchor link (@lex111)
- #1990 refactor(v2): make better a11y for tabs (@lex111)
- #2034 feat(v2): style sidebar on overflow (@endiliey)

📝 Documentation

Other
- #2068 docs(v2): quick proofread docs (@endiliey)
- #2047 docs(v2): add manual migration guide for versioning (@endiliey)
- #2036 docs(v2): Reorganize migration guide (@wgao19)
- #2052 fix(v2): make proper spelling of Yarn in tabs (@lex111)
- #2040 docs(v2): showcase user vector.dev :) (@binarylogic)
- #2038 docs(v2): add documentation on versioning (@endiliey)
- #2037 docs(v2): display yarn and npm command on website (@endiliey)
- #2051 docs(v2): more examples on lifecycle apis, cleanup (@endiliey)

🏠 Internal

docusaurus-plugin-content-blog
- #2072 refactor(v2): stronger typing for blog plugin (@endiliey)
docusaurus
- #2060 fix(v2): clean generated manifest from previous build so we dont use the wrong one (@endiliey)
- #2033 refactor(v2): move unused generated files out from build folder (@endiliey)
docusaurus-types, docusaurus
- #2043 refactor(v2): stronger typing for route gen (@endiliey)
docusaurus-mdx-loader, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus
- #2044 chore(v2): bump deps (@endiliey)
docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus
- #2029 chore(v2): bump deps and remove unused deps (@endiliey)

🏃‍♀️ Performance

docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag
- #2070 perf(v2): more performant gtag and analytics plugin (@endiliey)
docusaurus
- #2046 perf(v2): use webpack future version of asset emitting logic to free memory (@endiliey)
- #2039 perf(v2): replace unnecessary json stringify(string) with inline string (@endiliey)
- #2035 perf(v2): use @babel/runtime plugin to reduce codesize (@endiliey)
docusaurus-plugin-content-docs
- #2054 perf(v2): unblock metadata processing when possible (@endiliey)

Committers: 5

Alexey Pyltsyn (@lex111)
Binary Logic (@binarylogic)
Dongwoo Gim (@gimdongwoo)
Endi (@endiliey)
Wei Gao (@wgao19)

2.0.0-alpha.36

💥 Breaking Change

docusaurus-init, docusaurus-plugin-content-blog, docusaurus-theme-classic
- #1989 misc(v2): change blog front matter to snake_case (@yangshun)

🚀 New Feature

docusaurus-plugin-content-docs, docusaurus-theme-classic
- #2012 feat(v2): allow hiding docs table of contents (@yangshun)

🐛 Bug Fix

docusaurus
- #2007 feat(v2): only create one css file to avoid code-split css loading problem (@endiliey)
docusaurus-theme-classic
- #2005 fix(v2): adjust first-level heading offset (@lex111)

💅 Polish

docusaurus-theme-classic
- #2013 refactor(v2): split out dark mode toggle so it is easily swizzle-able (@endiliey)
- #2017 feat(v2): style right sidebar scrollbar when overflow (@endiliey)
- #2003 refactor(v2): improve semantic markup of blog (@lex111)

🏠 Internal

docusaurus
- #2024 test(v2): babel exclude transpilation logic to prevent regression (@endiliey)
- #2014 feat(v2): add meta generator docusaurus (@endiliey)
docusaurus-mdx-loader, docusaurus-plugin-ideal-image
- #2015 chore(v2): bump & remove unused deps (@endiliey)
Other
- #2009 misc(v2): branding update (@yangshun)

📝 Documentation

#2010 docs(v2): misc updates (@yangshun)

Committers: 3

Alexey Pyltsyn (@lex111)
Endi (@endiliey)
Yangshun Tay (@yangshun)

2.0.0-alpha.35

🚀 New Feature

docusaurus-theme-classic
- #1965 feat(v2): add ability specify link in footer logo (@lex111)

🐛 Bug Fix

docusaurus-mdx-loader, docusaurus-theme-classic
- #1992 fix(v2): static phrasing content should be rendered correctly in TOC (@endiliey)
docusaurus-theme-classic
- #1999 fix(v2): remove hashbang when click on category (@lex111)
- #1962 fix(v2): make not clickable post title on post item page (@lex111)
- #1980 fix(v2): remove invalid label attribute of footer links (@lex111)
- #1978 fix(v2): use regular div instead of main tag for wrapper layout page (@lex111)
- #1975 fix(v2): move header inside article tag in doc page (@lex111)
- #1974 fix(v2): remove invalid attributes of nav links (@lex111)
- #1963 fix(v2): remove empty containers when no data in blog pages (@lex111)
- #1966 fix(v2): remove duplicate meta tags (@lex111)
docusaurus-plugin-content-docs
- #1994 fix(v2): throw error if first level item of a sidebar is not category (@endiliey)

💅 Polish

docusaurus-theme-search-algolia
- #2001 fix(v2): improve UI of search (@lex111)
docusaurus-theme-classic
- #1991 fix(v2): remove accessible anchors via keyboard (@lex111)
- #1987 refactor(v2): replace h1 tag with h2 in blog list pages (@lex111)
- #1981 fix(v2): use tag time for showing last update of doc item (@lex111)
- #1977 feat(v2): add aria-label to read more links for a11y (@lex111)
- #1964 fix(v2): use tag time for showing post item date (@lex111)
docusaurus-plugin-content-docs
- #1994 fix(v2): throw error if first level item of a sidebar is not category (@endiliey)
Other
- #1986 fix(v2): remove obsolete iframe attributes (@lex111)
docusaurus-init
- #1982 feat(v2): add FB link to footer (@lex111)
docusaurus-plugin-content-blog
- #1968 refactor(v2): simplify blog truncate function (@endiliey)

📝 Documentation

Other
- #1988 docs(v2): fix syntax highlighting for YML code blocks (@lex111)
- #1976 docs(v2): Add section to blog document about feed location (@vinnytheviking)
- #1970 docs(v2): update configureWebpack utility functions (@jamiedavenport)
docusaurus-1.x
- #1961 docs(v1): remove exclusive language (@ericcarboni)

🏠 Internal

Other
- #2002 fix(v2): fix browser window menu icon on smaller screen (@lex111)
- #1986 fix(v2): remove obsolete iframe attributes (@lex111)
docusaurus-init
- #1982 feat(v2): add FB link to footer (@lex111)
docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus
- #1985 chore(v2): update dependencies (@endiliey)

🏃‍♀️ Performance

docusaurus
- #1979 perf(v2): reduce main bundle size by using es5 if possible (@endiliey)

Committers: 6

Alexey Pyltsyn (@lex111)
Endi (@endiliey)
Eric Carboni (@ericcarboni)
Jamie Davenport (@jamiedavenport)
Nick McCormick (@kenning)
Vincent van der Walt (@vinnytheviking)

2.0.0-alpha.34

🚀 New Feature

docusaurus-theme-classic
- #1956 feat(v2): add ability hide dark mode toggle (@lex111)

💥 Breaking Change

docusaurus-plugin-content-docs
- #1958 breaking(v2): editUrl should point to website instead of docsDir (@endiliey)

🐛 Bug Fix

docusaurus-theme-classic
- #1959 fix(v2): useTOC hooks should not be called in each nested children (@endiliey)

💅 Polish

docusaurus-plugin-content-docs, docusaurus
- #1957 refactor(v2): avoid synchronous/ blocking operation when possible (@endiliey)

📝 Documentation

#1953 fix(v2): update Infima website URL (@yangshun)

🏠 Internal

docusaurus-1.x, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus
- #1955 chore: bump dev dependencies (@endiliey)
Other
- #1952 chore(v2): add lerna-changelog (@endiliey)

🏃‍♀️ Performance

docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
- #1951 perf(v2): skip runtime fileHash cache in prod & get timestamp asynchronously (@endiliey)
- #1950 perf(v2): more efficient hot reload & consistent filegen (@endiliey)

Committers: 3

Alexey Pyltsyn (@lex111)
Endi (@endiliey)
Yangshun Tay (@yangshun)

2.0.0-alpha.33

Features

Table of contents is now highlighted depending on current active headings. (thanks to awesome @SantiagoGdaR) #1896
Official blog plugin can now generate feed for blog posts. (thanks to awesome @moozzyk) #1916

BREAKING prismTheme is renamed to theme as part new prism object in themeConfig field in your docusaurus.config.js. Eg:

 themeConfig: {
-   prismTheme: require('prism-react-renderer/themes/dracula'),
+   prism: {
+     theme: require('prism-react-renderer/themes/dracula'),
+   },
},

Added new prism option defaultLanguage that is used if the language is not specified in code blocks. #1910

Fixes

Fix babel/env not picking the correct browserslist configuration during development. When running docusaurus start, process.env.NODE_ENV is now consistently set to development.
Ensure routes config generation to be more consistent in ordering. Nested routes should be placed last in routes.js. This will allow user to create src/pages/docs.js to create custom docs page for /docs or even src/pages/docs/super.js to create page for /docs/super/;
Fix watcher does not trigger reload on windows.
Fix build compilation error if exists only one code tab.
Add minor padding to docs container so that hash-link won't be cut off.

Others

Misc dependency upgrades.
Stability improvement (more tests) & refactoring on docs plugin to prevent regression.

2.0.0-alpha.32

Features

Add <Redirect> component for client side redirect. Example Usage:

import React from 'react';
import {Redirect} from '@docusaurus/router';

function Home() {
  return <Redirect to="/docs/test" />;
}

Allow user to add custom HTML to footer items. #1905
Added code block line highlighting feature (thanks @lex111)! If you have previously swizzled the CodeBlock theme component, it is recommended to update your source code to have this feature. (#1860)

Bug Fixes

Fix @theme/Tabs component to be able to create tabs with only one item.
Fix MDX @theme/Heading component. If there is no id, it should not create anchor link.
Fixed a bug in which if themeConfig.algolia is not defined, the custom searchbar won't appear. If you've swizzled Algolia SearchBar component before, please update your source code otherwise CSS might break. See #1909 for reference.

- <Fragment>
+ <div className="navbar__search" key="search-box">

Slightly adjust search icon position to be more aligned on small width device. (#1893)
Fix algolia styling bug, previously search suggestion result is sometimes hidden. (#1915)
Changed the way we read the USE_SSH env variable during deployment to be the same as in v1.
Fix accessing docs/ or /docs/xxxx that does not match any existing doc page should return 404 (Not found) page, not blank page. (#1903)
Prioritize @docusaurus/core dependencies/ node_modules over user's node_modules. This fix a bug whereby if user has core-js@3 on its own node_modules but docusaurus depends on core-js@2, we previously encounter Module not found: core-js/modules/xxxx (because core-js@3 doesn't have that).
Fix a bug where docs plugin add /docs route even if docs folder is empty. We also improved docs plugin test coverage to 100% for stability before working on docs versioning. (#1912)

Performance Improvement

Reduce memory usage consumption. (#1900)
Significantly reduce main bundle size and initial HTML payload on production build. Generated files from webpack is also shorter in name. (#1898)
Simplify blog metadata. Previously, accessing /blog/post-xxx will request for next and prev blog post metadata too aside from target post metadata. We should only request target post metadata. (#1908)

Others

Convert sitemap plugin to TypeScript. (#1894)
Refactor dark mode toggle into a hook. (#1899)

2.0.0-alpha.31

Footer is now sticky/ pinned to the bottom of the viewport in desktop browsers.
Footer is now also displayed in docs page for consistency.
Remove empty doc sidebar container if sidebar for a particular doc page does not exist. Otherwise, it will cause an additional empty space.
Default PostCSS loader now only polyfills stage 3+ features (previously it was stage 2) like Create React App. Stage 2 CSS is considered relatively unstable and subject to change while Stage 3 features will likely become a standard.
Fix search bar focus bug. When you put the focus on search input, previously the focus will remain although we have clicked to other area outside of the search input.
New themeConfig option sidebarCollapsible. It is on by default. If explicitly set to false, all doc items in sidebar is expanded. Otherwise, it will still be a collapsible sidebar.
Disable adding hashes to the generated class names of CSS modules in dev mode. Generating unique identifiers takes some time, which can be saved since including paths to files in class names is enough to avoid collisions.
Fix showing sidebar category with empty items.
Update infima from 0.2.0-alpha.2 to 0.2.0-alpha.3
- Fix pagination nav and right sidebar color contrast ratio
- Fix sidebar arrow color in dark mode
- Fix footer mobile issue
- Increase sidebar width
- etc

2.0.0-alpha.30

Fix babel transpilation include/exclude logic to be more efficient. This also fix a very weird bug TypeError: Cannot assign to read only property 'exports' of object '#<Object>'.(#1868)

If you are still encountering the error. Please check whether you use module.exports for your .js file instead of doing export (mixing CJS and ES). See webpack/webpack#4039 (comment) and webpack/webpack#4039 (comment) for more context.

2.0.0-alpha.29

HOTFIX for 2.0.0-alpha.28.

Fix missing core-js dependencies on @docusaurus/core.
Fix wrong @babel/env preset configuration that causes build compilation error.
New UI for webpack compilation progress bar.

2.0.0-alpha.28

Further reduce memory usage to avoid heap memory allocation failure.
Fix keywords frontmatter for SEO not working properly.
Fix swizzle command not passing context properly to theme packages.
Add extendCli api for plugins. This will allow plugin to further extend Docusaurus CLI.
Fix swizzle command not being able to swizzle single js file.
Fix logo URL in footer to be appended with baseUrl automatically.
Add the option --no-open for start command.
Set @babel/env useBuiltins to usage. This will automatically use browserlist and import polyfills required.
Modified TerserWebpackPlugin terserOptions for better cross-browser compatibility.
BREAKING withBaseUrl is renamed to useBaseUrl because its a React Hooks. Make sure you import/rename it correctly. Eg: import useBaseUrl from '@docusaurus/useBaseUrl;
Fix potential security vulnerability because we're exposing the directory structure of the host machine.
Upgrade dependencies.

2.0.0-alpha.27

Add @theme/Tabs which can be used to implement multi-language code tabs.
Implement custom_edit_url and hide_title markdown header for docusaurus v1 feature parity.
Reduce memory usage and slightly faster production build.
Misc dependency upgrades.

2.0.0-alpha.26

Docs, pages plugin is rewritten in TypeScript
Docs improvements and tweaks
- Improved metadata which results in smaller bundle size.
- Docs sidebar can now be more than one level deep, theoretically up to infinity
- Collapsible docs sidebar!
- Make doc page title larger
- Add editUrl option (URL for editing) to docs plugin. If this field is set, there will be an "Edit this page" link for each doc page. Example: 'https://github.com/facebook/docusaurus/edit/master/docs'
- Add showLastUpdateTime and showLastUpdateAuthor options to docs plugin to further achieve v1 parity of showing last update data for a particular doc
Slight tweaks to the Blog components - blog title is larger now
Code Blocks
- Change default theme from Night Owl to Palenight
- Slight tweaks to playground/preview components
Add scripts and stylesheets field to docusaurus.config.js
More documentation...

2.0.0-alpha.25

Blog plugin is rewritten in TypeScript and can now support CJK
Upgrade key direct dependencies such as webpack, mdx and babel to latest
Do not escape html and body attributes
For devices with very small viewport width, the searchbar is replaced with a search icon. On tap of the search icon the searchbar is expanded and the text beside the logo is hidden and remains hidden while the search bar is expanded.
Add date frontMatter support for blog plugin
Add truncateMarker option to blog plugin, support string or regex.
Webpack optimization.removeAvailableModules is now disabled for performance gain. See https://github.com/webpack/webpack/releases/tag/v4.38.0 for more context.

2.0.0-alpha.24

Remove unused metadata for pages. This minimize number of http request & smaller bundle size.
Upgrade dependencies of css-loader from 2.x to 3.x. Css modules localIdentName hash now only use the last 4 characters instead of 8.
Fix broken markdown linking replacement for mdx files
Fix potential security vulnerability because we're exposing the directory structure of the host machine. Instead of absolute path, we use relative path from site directory. Resulting in shorter webpack chunk naming and smaller bundle size.
Use contenthash instead of chunkhash for better long term caching
Allow user to customize generated heading from MDX. Swizzle @theme/Heading

2.0.0-alpha.23

Fix docusaurus route config generation for certain edge case

2.0.0-alpha.22

Add missing dependencies on @docusaurus/preset-classic
New plugin @docusaurus/plugin-ideal-image to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder)
Better Twitter/discord image preview. Previously the size is too zoomed
Allow prism syntax highlighting theme customization. Refer to https://v2.docusaurus.io/docs/markdown-features#syntax-highlighting
CSS is now autoprefixed using postcss
Faster, lighter webpack bundle size
@docusaurus/theme-live-codeblock is now much smaller in size and no longer only load on viewport
Blog markdown files now support using the id field to specify the path

2.0.0-alpha.21

Fix babel-loader not transpiling docusaurus package

2.0.0-alpha.20

Add copy codeblock button
Add Google analytics and Google gtag plugins.
Move source components to /src. Please create a website/src directory and move your /pages and /theme code into it. This is to make it easier to integrate your website with external build/static analysis tooling (you can now just pass in src/**/*.js as the path to process).
Adde more documentation thanks to @wgao19.
Deprecate the current docs plugin. The docs plugin as of 2.0.0-alpha.19 is heavily based on V1 specifications and we intend to create a better one that fixes some of the inconsistencies in V1. If you have swizzled any doc components, you will have to update their names. You are highly encourages to not swizzle the legacy doc components until we have completed the new docs plugin.
Separate v2 init command to new package @docusaurus/init
Render 404.html page
Improve SEO
Clicking on the logo in the mobile sliding navigation will now bring you to the homepage.
Performance
- Disable webpack output pathinfo. Webpack has the ability to generate path info in the output bundle. However, this puts garbage collection pressure on projects that bundle thousands of modules. Not very useful for our case
- Drop cache-loader in CI and test environment because it has an initial overhead. We always start from scratch in vm instance like CI so cache-loader is useless
- Better splitchunks and babel default webpack config

2.0.0-alpha.19

Add a sensible default for browserslist config.
UI
- Add sun and moon emoji to the dark mode toggle.
- Mobile responsive menu.
- Right table of contents for docs is now sticky.
Plugins
- Change plugin definitions from classes to functions. Refer to the new plugin docs.
- Implement Clients module API.
- Change format within docusaurus.config.js to be like presets.
Deps
- Infima CSS is now locked down to specific versions and not relying upon the CDN which reads from trunk.
- Update dependencies to latest
Customize/ Override infima CSS variables by passing options into the classic preset.

presets: [
  [
    '@docusaurus/preset-classic',
    {
      theme: {
        customCss: require.resolve('./css/custom.css'),
      },
      ...
    },
  ],
],

Allow passing remark and rehype plugins to mdx-loader for docs and blog plugin
Move themes component of docs and blog to be part of theme-classic
Use composition style for prism syntax highlighting instead of doing it via rehype plugin
Pass MDXProvider to docs and blog. To change the provided MDX components, run docusaurus swizzle @docusaurus/theme-classic MDXComponents
Add @docusaurus/theme-livecodeblock plugin
Better run-time code generation & webpack splitchunks optimization
Minify css for production build
Fix weird scrolling problem when navigating to a route with a hash location

V2 Changelog

`siteConfig.js` changes

siteConfig.js renamed to docusaurus.config.js.
Remove the following config options:
- docsUrl. Use the plugin option on docusaurus-plugin-content-docs instead.
- customDocsPath. Use the plugin option on docusaurus-plugin-content-docs instead.
- sidebars.json now has to be explicitly loaded by users and passed into the the plugin option on docusaurus-plugin-content-docs.
- headerLinks doc, page, blog is deprecated and has been to moved into themeConfig under the name navbar. The syntax is now:

themeConfig: {
  navbar: {
    title: 'Docusaurus',
    logo: {
      alt: 'Docusaurus Logo',
      src: 'img/docusaurus.svg',
    },
    links: [
      {to: 'docs/introduction', label: 'Docs', position: 'left'},
      {to: 'blog', label: 'Blog', position: 'left'},
      {to: 'feedback', label: 'Feedback', position: 'left'},
      {
        href: 'https://github.com/facebook/docusaurus',
        label: 'GitHub',
        position: 'right',
      },
    ],
  },
}

Migration Guide

Work in Progress

Presets

Add presets for plugins that follow the Babel preset convention.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!