Docusaurus v2.0.0-beta.18 Release Notes

Release Date: 2022-03-25 // about 2 years ago
  • :rocket: New Feature

    • docusaurus-mdx-loader, docusaurus-theme-classic
      • #6990 feat: lazy-load external images + ability to customize image display (@slorber)
    • πŸ”Œ docusaurus-module-type-aliases, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus
      • #6933 feat(core,theme): useRouteContext + HtmlClassNameProvider (@slorber)
    • πŸ“ˆ docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus
      • #6921 feat(core): allow plugin lifecycles to return relative paths (@Josh-Cena)
    • docusaurus-theme-classic
    • πŸ”Œ docusaurus-plugin-content-docs
      • #6780 feat(content-docs): allow custom props through category.json (@taejs)

    :boom: Breaking Change

    • πŸ”Œ docusaurus-plugin-content-docs
      • #6859 feat(content-docs): autogenerate category with linked doc metadata as fallback (@Josh-Cena)
    • docusaurus-theme-classic
    • docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus
      • #6925 refactor(theme-{classic,common}): refactor site/page/search metadata + apply className on html element (@slorber)
    • docusaurus-theme-classic, docusaurus-theme-common
      • #6895 refactor(theme-{classic,common}): split navbar into smaller components + cleanup + swizzle config (@slorber)
      • #6930 refactor(theme-{classic,common}): refactor ColorModeToggle + useColorMode() hook (@lex111)

    :bug: Bug Fix

    • docusaurus
      • #6993 fix(core): prevent useBaseUrl returning /base/base when on /base (@Josh-Cena)
      • #6936 fix: remove semicolon from HTML output (@lex111)
      • #6849 fix(cli): write-heading-id should not generate colliding slugs when not overwriting (@Josh-Cena)
    • docusaurus-theme-classic
      • #6983 fix(search): bump Infima, fix search issue due to broken CSS selector (@slorber)
    • docusaurus-utils-validation
      • #6977 fix(validation): allow non-object params to remark/rehype plugins (@aloisklink)
    • πŸ”Œ docusaurus-plugin-content-docs, docusaurus-utils
      • #6973 fix(content-docs): suppress git error on multiple occurrences (@felipecrs)
    • πŸ”Œ docusaurus-plugin-content-blog
      • #6947 fix(content-blog): only create archive route if there are blog posts (@Josh-Cena)
      • #6918 fix(content-blog): remove double leading slash in blog-only paginated view (@heowc)
    • docusaurus-theme-search-algolia
      • #6888 fix(theme-algolia): declare content-docs as dependency (@Josh-Cena)
    • 🌐 docusaurus-theme-translations

    πŸ’… :nail_care: Polish

    • πŸ”Œ docusaurus-plugin-content-docs
      • #6859 feat(content-docs): autogenerate category with linked doc metadata as fallback (@Josh-Cena)
      • #6887 fix(content-docs): give context about sidebar loading failure (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-docs, docusaurus-utils-validation, docusaurus
      • #6997 fix(validation): improve error messages for a few schemas (@Josh-Cena)
    • docusaurus-theme-classic
      • #6971 refactor: improve a11y of dropdown menu (@lex111)
      • #6987 refactor(theme-classic): cleanup of code blocks (@lex111)
      • #6950 refactor(theme-classic): clean up CSS of doc cards (@lex111)
      • #6994 refactor: better external link icon positioning (@lex111)
      • #6989 refactor: extract MDX components (@slorber)
      • #6985 refactor(theme-classic): remove span wrappers from layout links (@lex111)
      • #6986 fix(theme-classic): minor code copy button improvements (@Josh-Cena)
      • #6964 refactor: replace text-based copy code button with icons (@lex111)
      • #6932 refactor(theme-classic): little breadcrumbs improvements (@lex111)
      • #6914 feat(theme-classic): set aria-expanded on expandable sidebar categories (@pkowaluk)
      • #6844 refactor(theme-classic): split sidebar into smaller parts (@slorber)
      • #6846 refactor(theme-classic): consistently add span wrapper for layout links (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus-utils, docusaurus
    • docusaurus-theme-common
    • docusaurus
      • #6784 feat(core): allow configureWebpack to return undefined (@yorkie)
      • #6941 refactor(core): improve error message when a page has no default-export (@Josh-Cena)
      • #6878 fix(core): ensure stable webpack theme aliases sorting (@jrvidal)
      • #6854 fix(core): fix swizzle legend typo (@DigiPie)
      • #6850 fix(core): make plugin lifecycles consistently bound to the plugin instance (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils
    • docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus
      • #6925 refactor(theme-{classic,common}): refactor site/page/search metadata + apply className on html element (@slorber)
    • docusaurus-theme-classic, docusaurus-theme-common
      • #6895 refactor(theme-{classic,common}): split navbar into smaller components + cleanup + swizzle config (@slorber)
      • #6930 refactor(theme-{classic,common}): refactor ColorModeToggle + useColorMode() hook (@lex111)
      • #6894 refactor(theme-classic): split theme footer into smaller components + swizzle config (@slorber)
    • docusaurus-types, docusaurus
    • πŸ”Œ docusaurus-plugin-client-redirects, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap
      • #6928 chore(pwa, sitemap, client-redirects, ideal-image): JSDoc for types (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-utils
      • #6922 refactor(content-blog): clean up type definitions; in-code documentation (@Josh-Cena)
    • 🌐 docusaurus-theme-translations
      • #6781 feat(theme-translations): complete Russian translations (@dragomano)
      • #6877 chore(theme-translations): complete Vietnamese translations (@datlechin)
    • πŸ”Œ docusaurus-plugin-content-blog
      • #6909 refactor(content-blog): improve error message of authors map validation (@Josh-Cena)
    • create-docusaurus
      • #6860 fix(create): load entry file after node version checking (@taejs)

    πŸ“š :memo: Documentation

    :house: Internal

    • 🌐 create-docusaurus, docusaurus-mdx-loader, docusaurus-migrate, 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-gtag, docusaurus-plugin-ideal-image, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
      • #6995 refactor: ensure all types are using index signature instead of Record (@Josh-Cena)
    • πŸ”Œ create-docusaurus, docusaurus-cssnano-preset, docusaurus-plugin-pwa, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, lqip-loader
    • lqip-loader
    • docusaurus
      • #6975 chore: update static-site-generator-webpack-plugin (@slorber)
    • πŸ’… stylelint-copyright
    • πŸ“ˆ docusaurus-plugin-client-redirects, 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-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils-validation, docusaurus
    • docusaurus-types
    • docusaurus-theme-common, docusaurus
      • #6956 test: improve test coverage; reorder theme-common files (@Josh-Cena)
      • #6955 refactor(core): move browserContext and docusaurusContext out of client exports (@Josh-Cena)
      • #6944 chore: migrate Jest and website to SWC (@Josh-Cena)
    • docusaurus-utils
    • πŸ’… 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-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils, docusaurus, stylelint-copyright
    • πŸ”Œ docusaurus-module-type-aliases, docusaurus-plugin-client-redirects
      • #6924 refactor(client-redirects): migrate validation to validateOptions lifecycle (@Josh-Cena)
    • πŸ”Œ create-docusaurus, docusaurus-cssnano-preset, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus, lqip-loader
    • πŸ’… create-docusaurus, docusaurus-plugin-content-docs, docusaurus-theme-translations, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus, stylelint-copyright
      • #6912 test: improve test coverage; multiple internal refactors (@Josh-Cena)
    • Other
      • #6910 refactor: convert Jest infrastructure to TS (@Josh-Cena)
      • #6838 fix(website): changelog plugin leads to CI bugs on release (@slorber)
    • πŸ”Œ docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-utils, docusaurus
    • πŸ”Œ docusaurus-migrate, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-utils-validation, docusaurus-utils, docusaurus
    • πŸ”Œ docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils, docusaurus
      • #6905 test: improve test coverage; properly test core client APIs (@Josh-Cena)
    • 🌐 docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-sitemap, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-translations, docusaurus-utils, docusaurus
    • πŸ”Œ docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-types, docusaurus-utils-common, docusaurus-utils, docusaurus, lqip-loader
    • πŸ’… 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-sitemap, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-theme-translations, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright
    • 🌐 docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
      • #6898 refactor: import jest as global; unify import style of some modules (@Josh-Cena)
    • docusaurus-theme-classic, docusaurus-theme-common
      • #6891 refactor(theme-classic): avoid using clsx class dict with CSS modules (@Josh-Cena)
    • 🌐 docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-translations, docusaurus-utils, docusaurus
      • #6880 refactor: prefer fs.outputFile to ensureDir + writeFile (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-pwa, docusaurus-types, docusaurus
    • πŸ”Œ docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-pwa, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus, lqip-loader
      • #6864 refactor: remove unnecessary default values normalized during validation (@Josh-Cena)
    • create-docusaurus, docusaurus-migrate, docusaurus
      • #6861 refactor: make JS executables included in the tsconfig for editor hints (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-types, docusaurus
    • πŸ”Œ docusaurus-logger, docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils-common, docusaurus-utils, docusaurus, lqip-loader

    Committers: 28