Docusaurus v2.0.0-beta.15 Release Notes

Release Date: 2022-01-26 // about 2 years ago
  • :rocket: New Feature

    • πŸ”Œ docusaurus-plugin-content-docs
      • #6451 feat(content-docs): expose isCategoryIndex matcher to customize conventions (@Josh-Cena)
      • #5782 feat(content-docs): displayed_sidebar front matter (@Josh-Cena)
    • docusaurus-theme-classic, docusaurus-theme-common
    • πŸ”Œ docusaurus-plugin-content-blog, docusaurus-theme-classic
      • #6416 feat(content-blog): allow authors list to contain images only (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-blog
    • docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus-types, docusaurus
      • #6371 feat(core, theme-classic): allow overriding htmlLang (@noomorph)
    • docusaurus-mdx-loader
      • #6323 feat(mdx-loader): preserve hash in image src; support GH themed images (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-docs, docusaurus-theme-classic
      • #6139 feat(theme-classic): new navbar item linking to a sidebar (@lmpham1)
      • #6239 feat(content-docs): allow SEO metadata for category index pages (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-sitemap
      • #6248 feat(sitemap): remove trailingSlash option; respect noIndex config (@Josh-Cena)
    • 🌐 docusaurus-plugin-ideal-image, docusaurus-theme-translations
    • πŸ”Œ docusaurus-plugin-ideal-image
    • 🌐 docusaurus-theme-translations
    • πŸ”Œ docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus
    • docusaurus
      • #6165 feat(core): async docusaurus.config.js creator function (@slorber)

    :boom: Breaking Change

    • docusaurus-theme-search-algolia
      • #6407 feat(search): enable contextual search by default (@slorber)
    • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia
      • #6289 refactor: move @theme/hooks to @docusaurus/theme-common (@slorber)
    • docusaurus-theme-classic
      • #6283 refactor(theme-classic): apply import/no-named-export eslint rule (@slorber)
    • πŸ”Œ docusaurus-plugin-sitemap
      • #6248 feat(sitemap): remove trailingSlash option; respect noIndex config (@Josh-Cena)

    :bug: Bug Fix

    • πŸ”Œ docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-types, docusaurus-utils-common, docusaurus-utils, docusaurus
      • #6454 fix(content-blog): generate feed by reading build output (@Josh-Cena)
    • create-docusaurus
    • docusaurus-mdx-loader
      • #4827 fix: allow links to JSON in .md files to be transformed as asset links (@antmcc49)
    • πŸ”Œ docusaurus-plugin-content-docs
      • #6435 fix(content-docs): make getActivePlugin match plugin paths more exactly (@Josh-Cena)
      • #6310 fix: highlight appropriate navItem when browsing generated category index (@tapanchudasama)
      • #6202 fix(content-docs): quotify path when retrieving git history (@Josh-Cena)
    • docusaurus
      • #6424 fix(core): fix css url("image.png"), use css-loader v6 with esModules: false (@slorber)
      • #6378 fix(core): do not coerce webpack warning to string (@Josh-Cena)
      • #6197 fix(cli): quotify temp path in deploy command (@Josh-Cena)
      • #6168 fix(core): update webpack-dev-server + fix deprecation warning (@slorber)
    • docusaurus-logger, docusaurus-utils
    • docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus
      • #6338 fix(core): error boundary should allow no children (@slorber)
    • docusaurus-theme-classic
      • #6314 fix(theme-classic): fix mobile version dropdown label with only one version (@Josh-Cena)
      • #6288 fix(theme-classic): add missing role=region to SkipToContent (@JoshuaKGoldberg)
      • #6213 refactor(theme-classic): extract common PaginatorNavLink component (@Josh-Cena)
      • #6177 fix(theme-classic): make React elements in pre render correctly (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-search-algolia
      • #6300 refactor: move exported type definitions to declaration file (@Josh-Cena)
    • docusaurus-migrate
      • #6276 fix(migrate): migration CLI should correctly migrate gtag options (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-blog
      • #6244 fix(content-blog): always convert front matter date as UTC (@Josh-Cena)
    • docusaurus-mdx-loader, docusaurus-utils, docusaurus

    πŸ’… :nail_care: Polish

    • docusaurus-module-type-aliases
      • #6469 fix(module-type-aliases): fix type def for translate params (@Josh-Cena)
    • docusaurus-theme-search-algolia
      • #6407 feat(search): enable contextual search by default (@slorber)
    • docusaurus-mdx-loader
      • #6443 refactor(mdx-loader): use vfile.path to access Markdown file path (@Josh-Cena)
    • docusaurus-theme-classic
      • #6427 feat(theme-classic): add aria-current to sidebar category link (@Josh-Cena)
      • #6391 refactor(theme-classic): add comments to Prism setup; minor refactor (@Josh-Cena)
      • #6240 refactor(theme-classic): use front matter from metadata for BlogPostPage (@Josh-Cena)
    • docusaurus
      • #6419 feat(core): warn users about hand-modifying generated files (@Josh-Cena)
      • #6405 feat(core): check imported API name when extracting translations (@Josh-Cena)
      • #6291 feat(core): improve error message for BrowserOnly; better docs (@Josh-Cena)
    • create-docusaurus
      • #5822 feat: update website & init template palette to pass WCAG test; include contrast check in ColorGenerator (@Josh-Cena)
      • #6368 fix(create-docusaurus): add useBaseUrl for image URLs (@alias-mac)
    • πŸ”Œ docusaurus-plugin-content-pages, docusaurus-theme-classic
      • #6400 feat(content-pages): front matter validation, include front matter in metadata (@Josh-Cena)
    • docusaurus-mdx-loader, docusaurus-theme-classic
      • #6339 feat(mdx-loader): read image dimensions when processing Markdown (@Josh-Cena)
    • πŸ”Œ docusaurus-plugin-content-blog
    • docusaurus-theme-common
    • πŸ”Œ docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus-utils, docusaurus
    • πŸ“ˆ docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-preset-classic
      • #6284 fix(preset-classic): throw if preset finds GA options in theme config (@Josh-Cena)
    • create-docusaurus, docusaurus
      • #6186 refactor: print trailing new line when outputting JSON (@Josh-Cena)

    πŸ“š :memo: Documentation

    :house: Internal

    • πŸ”Œ docusaurus-mdx-loader, docusaurus-migrate, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus-utils, docusaurus
    • Other
    • πŸ”Œ docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus
    • πŸ”Œ docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus
      • #6440 chore: remove some unused dependencies from package.json (@Josh-Cena)
    • docusaurus-theme-classic
      • #6436 refactor(theme-classic): render BlogPostItem as one JSX element (@Josh-Cena)
      • #6283 refactor(theme-classic): apply import/no-named-export eslint rule (@slorber)
    • πŸ”Œ docusaurus-plugin-content-pages
      • #6413 fix(content-pages): declare hide_table_of_contents as boolean (@Josh-Cena)
    • docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-theme-classic, docusaurus
    • 🌐 docusaurus-cssnano-preset, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-common, docusaurus-theme-translations, docusaurus
    • docusaurus-utils
    • πŸ”Œ docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
    • πŸ’… 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-search-algolia, docusaurus-utils-common, docusaurus-utils, docusaurus, stylelint-copyright
    • create-docusaurus
    • πŸ’… docusaurus-theme-classic, stylelint-copyright
    • docusaurus-cssnano-preset, docusaurus-theme-classic
    • πŸ”Œ create-docusaurus, docusaurus-plugin-debug, docusaurus-theme-classic
    • docusaurus-theme-search-algolia, docusaurus-utils-validation, docusaurus
    • πŸ”Œ docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-pages, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus
    • πŸ’… create-docusaurus, 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-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-search-algolia, docusaurus-theme-translations, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright
    • docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia
      • #6289 refactor: move @theme/hooks to @docusaurus/theme-common (@slorber)
    • πŸ”Œ docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-search-algolia
      • #6287 refactor: new @docusaurus/plugin-content-docs/client interface (@slorber)
    • docusaurus
      • #6279 refactor(core): use native types from webpack-dev-server (@RDIL)
    • πŸ”Œ docusaurus-plugin-content-docs
      • #6277 refactor(content-docs): make readVersionsMetadata async (@Josh-Cena)
    • docusaurus-types, docusaurus
    • πŸ”Œ create-docusaurus, docusaurus-logger, 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-pwa, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-utils-common, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader
    • πŸ”Œ create-docusaurus, docusaurus-plugin-content-blog, docusaurus-utils, docusaurus
      • #6229 refactor(utils): reorganize functions; move authors file resolution to utils (@Josh-Cena)
    • 🌐 docusaurus-theme-translations
      • #6225 refactor(theme-translations): improve typing for update script (@Josh-Cena)
      • #6174 misc(theme-translations): multiple improvements to the update CLI (@Josh-Cena)

    Committers: 46