2.0.0-beta.19

2.0.0-beta.19 (2022-05-04)

🚀 New Feature

• docusaurus-theme-classic, docusaurus-theme-common
  • #7178 feat(theme-classic): extensible code block magic comment system (@Josh-Cena)
  • #7007 feat(theme-classic): code block showLineNumbers (@lex111)
  • #7012 feat(theme-classic): show blog sidebar on mobile (@Josh-Cena)
• docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus, eslint-plugin
  • #7206 feat: Docusaurus ESLint plugin to enforce best Docusaurus practices (@elias-pap)
• docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-theme-classic, docusaurus-types, docusaurus
  • #6732 feat(core): rework client modules lifecycles, officially make API public (@Josh-Cena)
• docusaurus-theme-classic
  • #7231 feat: allow custom navbarItem types to pass through validation (@slorber)
  • #7058 feat(theme-classic): new 'html' type navbar item (@lex111)
  • #7079 feat: allow using pure HTML as label in navbar links (@lex111)
• docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-translations
  • #7036 feat(theme-classic): toggle code wrap button (@lex111)
• docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common
  • #6457 feat(content-docs): draft docs excluded from build & sidebars (@jodyheavener)
• docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-types, docusaurus
  • #6430 feat: allow setting calendar for i18n date formatting (@Josh-Cena)
• docusaurus-module-type-aliases, docusaurus-plugin-content-docs, docusaurus-types, docusaurus
  • #7083 feat(core): fail-safe global data fetching (@Josh-Cena)
• docusaurus-plugin-content-docs
  • #7106 feat(content-docs): make docs:version command work on localized docs (@Josh-Cena)
• docusaurus-types, docusaurus
  • #7082 feat(core): allow plugins to declare custom route context (@Josh-Cena)
  • #7124 feat(core): allow plugin/preset config to contain false/null (@Josh-Cena)
• docusaurus-plugin-sitemap, docusaurus-utils
  • #6979 feat(sitemap): add ignorePatterns option (@ApsarasX)

💥 Breaking Change

• docusaurus-types, docusaurus
  • #7257 refactor: remove long-deprecated routesLoaded lifecycle (@Josh-Cena)
• docusaurus-theme-classic, docusaurus-theme-common
  • #7277 refactor(theme-classic): move all sidebar-related config under themeConfig.docs.sidebar (@Josh-Cena)
• docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-theme-classic, docusaurus-types, docusaurus
  • #6732 feat(core): rework client modules lifecycles, officially make API public (@Josh-Cena)
• create-docusaurus, docusaurus-theme-classic
  • #7176 refactor: customize code block line highlight color via CSS var (@lex111)
• docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation, docusaurus-utils
  • #7117 refactor(content-{blog,docs}): unify handling of tags (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-live-codeblock
  • #7027 refactor(content-docs): deduplicate types, JSDoc for some APIs (@Josh-Cena)

🐛 Bug Fix

• docusaurus-theme-classic
  • #7304 fix(theme-classic): remove breadcrumb items without href from microdata (@Josh-Cena)
  • #7179 fix(theme-classic): do not add microdata item prop to trailing breadcrumb (@Josh-Cena)
  • #7173 fix(theme-classic): admonition title: disable text-transform on inline code blocks (@chelproc)
  • #7048 fix(theme-classic): add caret for dropdown on mobile (@lex111)
  • #7025 fix: make docs page wrapper take full height (@lex111)
  • #7013 fix(theme-classic): adjust shadow on code block (@chernodub)
  • #7015 fix(theme-classic): do not add caret for non-collapsible categories (@Josh-Cena)
• 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-sitemap, docusaurus-preset-classic, docusaurus-theme-classic
  • #7294 fix(*): make TypeScript realize that each plugin package has a default export (@Josh-Cena)
• docusaurus
  • #7285 fix(core): allow empty static directories (@Josh-Cena)
  • #7180 fix: pass pollOptions to webpack (@JohnnyMcWeed)
  • #7184 fix(core): prevent 404 when accessing /page.html (@Josh-Cena)
  • #7225 fix: allow swizzling a component's parent folder (@slorber)
  • #7066 fix(core): all plugin lifecycles should receive translated content (@Josh-Cena)
• docusaurus-plugin-content-docs
  • #7233 fix(content-docs): make category index text translatable (@Josh-Cena)
• docusaurus-theme-common
  • #7200 fix(theme-common): do not persist color mode for OS-triggered changes (@Josh-Cena)
  • #7057 fix(theme-common): use native scrolling when smooth behavior set in CSS (@Josh-Cena)
  • #7033 fix(theme): only parse HTML- and JSX-style comments in MD code (@Josh-Cena)
• docusaurus-plugin-content-blog
  • #7212 fix(content-blog): make footnote reference DOM ID unique on post listing page (@AkiraVoid)
• docusaurus-utils, docusaurus
  • #7187 fix(core): handle case where package.json is not available at CWD (@Josh-Cena)
• docusaurus-theme-translations
  • #7222 fix(theme-translations): fix invalid pluralization in cs (@Josh-Cena)
  • #7166 fix(theme-translations): always try all possible locale resolutions (@Josh-Cena)
• docusaurus-theme-classic, docusaurus-theme-search-algolia
  • #7164 fix: adjust spacing for custom search properly (@lex111)
• docusaurus-plugin-debug, docusaurus-plugin-sitemap, docusaurus-preset-classic, docusaurus-types, docusaurus
  • #7143 fix(sitemap): exclude pages with robots noindex from sitemap (@Josh-Cena)
• create-docusaurus, docusaurus-types
  • #7078 fix(create): install types for JS template as well (@Josh-Cena)
• docusaurus-utils
  • #7043 fix(utils): parse Markdown headings with CRLF line break (@Josh-Cena)
• docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
  • #7023 refactor: fix a few places of path handling (@Josh-Cena)
• docusaurus-types
  • #7014 fix(types): declare history and react-loadable as dependencies (@sulu5890)

💅 Polish

• docusaurus-theme-classic, docusaurus-theme-translations
  • #7299 refactor: minor improvements for breadcrumbs (@lex111)
• create-docusaurus
  • #7290 refactor(create): add i18n config in init template (@Josh-Cena)
  • #7286 refactor(create): update screenshots in quick start tutorial (@Josh-Cena)
  • #7223 refactor: use generated-index in init templates (@slorber)
  • #7118 refactor(create): mention that the edit links can be removed (@Josh-Cena)
• docusaurus-plugin-debug, docusaurus-theme-classic
  • #7306 chore: upgrade Infima to alpha.39 (@lex111)
• docusaurus-plugin-debug, docusaurus-types, docusaurus
  • #7291 feat(types): JSDoc for docusaurus config fields (@Josh-Cena)
• docusaurus-theme-classic, docusaurus-theme-common
  • #7267 fix(theme-common): allow details to not provide a summary (@Josh-Cena)
  • #7172 refactor: control base styling of code blocks via CSS vars (@lex111)
  • #7129 refactor(theme-classic): fix a few margin inconsistencies (@lex111)
• docusaurus-plugin-content-docs, docusaurus-utils
  • #7248 refactor: normalize Markdown linkification behavior, elaborate in documentation (@Josh-Cena)
• docusaurus-theme-classic
  • #7244 refactor: semantic markup improvement, fix validation warnings (@Josh-Cena)
  • #7183 refactor: use SVG icon for home breadcrumb (@Dr-Electron)
  • #7139 fix: proper spacing between generated card items on mobiles (@lex111)
  • #7134 fix(theme-classic): fix docs sidebar layout shifts when expanding categories (@slorber)
  • #7068 refactor(theme-classic): blog mobile secondary menu use consistent styles (@Josh-Cena)
  • #7004 fix(theme-classic): shrink title size on mobile (@Pierre-Gilles)
• docusaurus-theme-translations
  • #7214 chore(theme-translations): complete Polish translations (@rev4324)
  • #7031 chore(theme-translations): complete German translations (@deployn)
• create-docusaurus, docusaurus-theme-classic
  • #7176 refactor: customize code block line highlight color via CSS var (@lex111)
• docusaurus
  • #7218 fix(cli): always show error stack to unhandled rejection (@Josh-Cena)
  • #7142 refactor(core): lower timeout before rendering progress bar to 200ms (@Josh-Cena)
  • #7103 fix(core): preserve Interpolate children semantics (@Josh-Cena)
  • #7029 refactor: console output improvements (@lex111)
  • #7017 refactor: remove copyright comment from swizzled components (@lex111)
• docusaurus-plugin-content-docs, docusaurus-preset-classic, docusaurus-theme-classic
  • #7148 feat(preset-classic, content-docs/client): JSDoc (@Josh-Cena)
• docusaurus-plugin-debug, docusaurus-preset-classic
  • #7122 feat(preset-classic): exclude debug plugin routes from sitemap (@lex111)
• docusaurus-theme-common, docusaurus-utils, docusaurus
  • #7113 test: improve test coverage (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-migrate, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-remark-plugin-npm2yarn, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-types, docusaurus-utils-validation, docusaurus
  • #7080 refactor: replace non-prop interface with type; allow plugin lifecycles to have sync type (@Josh-Cena)
• create-docusaurus, docusaurus-logger, docusaurus-plugin-content-docs, docusaurus
  • #7019 feat(logger): new "url" format, add double quotes around paths (@lex111)
• docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common
  • #7006 refactor: split and cleanup theme/DocPage (@slorber)
• docusaurus-plugin-content-docs, docusaurus-theme-classic
  • #7005 refactor: split DocSidebarItem by item type (@slorber)

📝 Documentation

• docusaurus-logger
  • #7305 docs: update docs for logger, add API docs to website (@Josh-Cena)
• Other
  • #7284 docs: add a paragraph about SSR as an optimization technique (@Josh-Cena)
  • #7278 docs: enhance docs about Markdown TOC and metadata (@Josh-Cena)
  • #7271 docs: specify Node version requirement to a minor (@DanRoscigno)
  • #7252 docs: update gtag docs to reflect what a GA4 tag looks like (@johnnyreilly)
  • #7240 docs: add PCC Archive site to showcase (@CuratorCat)
  • #7239 docs: add Chaos mesh site to showcase (@cwen0)
  • #7235 docs: add TiDB community books to showcase (@shczhen)
  • #7236 docs: add documentation about pluralization (@Josh-Cena)
  • #7230 docs: add OSS Insight to showcase (@sykp241095)
  • #7208 docs: remove mention of "template" from README installation guide (@Josh-Cena)
  • #7159 docs: explain more clearly the purpose of a ref sidebar type (@andrewnicols)
  • #7126 docs: multiple documentation improvements (@Josh-Cena)
  • #7123 refactor(showcase): enforce descriptions with maximum length of 120 characters (@Josh-Cena)
  • #7026 docs: correct plugin example filename (@mxhdx)
  • #7110 docs: add a note about additional languages needing to be Prism component names (@Josh-Cena)
  • #6746 fix(website): lazy-load YT iframe (@Josh-Cena)
  • #7061 docs: add docusaurus-plugin-typedoc to resources (@nartc)
  • #7059 docs: add firelordjs to showcase (@Josh-Cena)
  • #7050 docs: add import React statement in JSX file example (@kaycebasques)
  • #7022 docs: add Easypanel to showcase (@deiucanta)
  • #7016 docs: consistently use sidebars.js filename (@leedom92)
  • #7020 docs: add Divine WSF and Ghostly to showcase (@LeviticusMB)
  • #7000 docs: remove unnecessary semicolon (@imsingh)
• docusaurus-plugin-content-docs, docusaurus-utils
  • #7248 refactor: normalize Markdown linkification behavior, elaborate in documentation (@Josh-Cena)
• create-docusaurus, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils
  • #7081 docs: fix some casing inconsistencies (@Josh-Cena)

🔧 Maintenance

• Other
  • #7309 chore: use "Maintenance" instead of "Internal" in changelog (@Josh-Cena)
  • #7300 misc: check doc page by Lighthouse CI (@lex111)
  • #7266 misc: add links section to PR template (@slorber)
  • #7224 chore: GitHub Actions cancel-in-progress (@slorber)
  • #7216 chore: remove netlify-cli from devDependencies (@Josh-Cena)
  • #7211 chore: replace node 17 with 18 in CI matrix (@Josh-Cena)
  • #7168 misc: add CI actions/dependency-review-action for security (@slorber)
  • #6984 misc: pin actions to a full-length commit SHA (@naveensrinivasan)
  • #7002 chore: regen examples for 2.0 beta.18 (@slorber)
• docusaurus-logger, docusaurus-remark-plugin-npm2yarn
  • #7295 refactor: use export = syntax for Node utility packages (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus
  • #7293 refactor(types): move non-core, non-public types out of the types package (@Josh-Cena)
• docusaurus-types, docusaurus
  • #7292 refactor(core): collocate CLI commands and their option types (@Josh-Cena)
  • #7084 refactor(core): code cleanup (@Josh-Cena)
• docusaurus-module-type-aliases, docusaurus
  • #7282 refactor(core): prefetch/preload refactor (@Josh-Cena)
• docusaurus-theme-classic, docusaurus-theme-common
  • #7273 refactor(theme-classic): multiple re-arrangements (@Josh-Cena)
  • #7268 refactor(theme-classic): DocPage theme refactors polish (@slorber)
  • #7269 refactor: extract useSkipToContent() (@slorber)
  • #7175 refactor(theme-classic): split CodeBlock (@slorber)
  • #7067 refactor(theme-classic): extract doc-related navbar items' logic to theme-common (@Josh-Cena)
  • #7021 refactor(theme): extract plumbing code of BTT button into theme-common (@Josh-Cena)
• docusaurus-theme-classic
  • #7270 refactor(theme-classic): refactor TOC-related theme components (@slorber)
• docusaurus
  • #7220 refactor(cli): normalize the application of default option values (@Josh-Cena)
  • #7141 refactor(core): minor PendingNavigation refactor (@Josh-Cena)
• docusaurus-plugin-content-docs
  • #7243 chore: upgrade Jest to 28; add GitHub-actions reporter (@Josh-Cena)
  • #7140 refactor(content-docs): split version handling into several files (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-live-codeblock, docusaurus
  • #7194 fix: fix a few internal declaration semantic errors (@Josh-Cena)
• create-docusaurus, docusaurus-migrate, docusaurus-theme-translations, docusaurus
  • #7186 refactor: prefer fs.readJSON over readFile.then(JSON.parse) (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages
  • #7145 refactor: unify how MDX content types are represented (@Josh-Cena)
• 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-classic, docusaurus-theme-common, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader
  • #7138 chore: upgrade dependencies + upgrade React types (@Josh-Cena)
• 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-validation, docusaurus-utils, docusaurus
  • #7131 chore: disable string escaping in snapshots (@Josh-Cena)
• docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-theme-common, docusaurus-types, docusaurus-utils, docusaurus
  • #7054 refactor(core): refactor routes generation logic (@Josh-Cena)
• docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-types, docusaurus
  • #7042 refactor(core): reorganize files (@Josh-Cena)
• docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
  • #7037 refactor(core): reorganize functions (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-theme-live-codeblock
  • #7027 refactor(content-docs): deduplicate types, JSDoc for some APIs (@Josh-Cena)

🏃‍♀️ Performance

• docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-common, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-utils-common
  • #7085 refactor: mark a few client-side packages as side-effect-free (@Josh-Cena)
• docusaurus-mdx-loader, docusaurus-remark-plugin-npm2yarn
  • #4997 perf(mdx-loader): cache mdx/remark compiler instances (@phryneas)

Committers: 47

• Aaron Nwabuoku (@aerovulpe)
• AkiraVoid (@AkiraVoid)
• Alexey Pyltsyn (@lex111)
• Andrei Canta (@deiucanta)
• Andrew Lyons (@andrewnicols)
• ApsarasX (@ApsarasX)
• Chau Tran (@nartc)
• Chinazaekpere Ngubo (@dr-ngubo)
• Cwen Yin (@cwen0)
• Dan Roscigno (@DanRoscigno)
• Elias Papavasileiou (@elias-pap)
• Evan (@sulu5890)
• Fusang❀ (@cxOrz)
• Indermohan Singh (@imsingh)
• JMW (@JohnnyMcWeed)
• Jeffrey Aven (@jeffreyaven)
• Jody Heavener (@jodyheavener)
• John Reilly (@johnnyreilly)
• Joshua Chen (@Josh-Cena)
• Karl Ward (@mjau-mjau)
• Kayce Basques (@kaycebasques)
• Leedom (@leedom92)
• Lenz Weber-Tronic (@phryneas)
• Lukas Bach (@lukasbach)
• Martin Blom (@LeviticusMB)
• Naveen (@naveensrinivasan)
• Pablo Cordon (@pcordon)
• Pierre-Gilles Leymarie (@Pierre-Gilles)
• Qi Zhang (@zzzhangqi)
• Sébastien Lorber (@slorber)
• Viktor Chernodub (@chernodub)
• Zac A (@sandypockets)
• @Dr-Electron
• @chelproc
• @deployn
• @duanwilliam
• @kgolubic
• @redhat123456
• @surendran82
• @svix-ken
• apq (@AntonPalmqvist)
• curatorcat.pcc.eth (@CuratorCat)
• czhen (@shczhen)
• loic (@layerzzzio)
• mehdim (@mxhdx)
• rev (@rev4324)
• sykp241095 (@sykp241095)