Skip to content

Latest commit

 

History

History
2253 lines (1838 loc) · 166 KB

CHANGELOG-2.x.md

File metadata and controls

2253 lines (1838 loc) · 166 KB

Docusaurus 2 Changelog

2.0.0-alpha.66 (2020-10-19)

🚀 New Feature

  • docusaurus-plugin-content-blog, docusaurus-theme-classic
  • docusaurus-mdx-loader, docusaurus-remark-plugin-npm2yarn
  • docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia
    • #3550 feat(v2): contextual search, dynamic Algolia facetFilters (@slorber)
  • docusaurus-theme-classic
    • #3580 feat(v2): allow to define custom CSS class for Tabs component (@Simek)
    • #3553 feat(v2): make dropdown menu collapsible on mobiles (@lex111)
  • docusaurus-migrate, docusaurus-types, docusaurus
  • docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus
  • docusaurus-theme-classic, docusaurus
    • #3548 feat(v2): version dropdown before/after items + move site "All Versions" link (@slorber)
  • docusaurus-types, docusaurus
  • docusaurus-plugin-content-docs, docusaurus-theme-classic

💥 Breaking Change

  • docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia
    • #3550 feat(v2): contextual search, dynamic Algolia facetFilters (@slorber)

🐛 Bug Fix

  • docusaurus-theme-classic, docusaurus
    • #3607 fix(v2): fix error with required href attr of link in mobiles (@lex111)
  • docusaurus-theme-classic
    • #3602 fix(v2): make dropdown button clickable with mouse (@lex111)
    • #3601 fix(v2): fix table-of-content scroll highlighting issues (@slorber)
  • docusaurus-theme-bootstrap, docusaurus-theme-classic
    • #3599 fix(v2): remove event listeners on Tabs component unmount (@lex111)
  • docusaurus-types, docusaurus

💅 Polish

  • docusaurus-theme-classic
    • #3585 refactor(v2): various dropdown improvements (@lex111)
    • #3588 refactor(v2): make accessible copy code button from keyboard (@lex111)
    • #3578 refactor(v2): apply common behavior to dropdowns (@lex111)
    • #3546 docs: various fixes and improvements (@lex111)
  • docusaurus-theme-classic, docusaurus
  • docusaurus
    • #3569 refactor(v2): improve broken links error message (@slorber)

📝 Documentation

🏠 Internal

  • docusaurus-theme-search-algolia
    • #3591 chore(v2): enable new contextual search feature (@slorber)
  • Other
  • docusaurus-theme-classic
    • #3394 refactor(v2): add useThemeConfig hook + cleanup useless theme default values (@imskr)

Committers: 17

2.0.0-alpha.65 (2020-10-02)

🚀 New Feature

  • docusaurus
    • #3497 feat(v2): env variable TERSER_PARALLEL to customize TerserPlugin.parallel (@aeneasr)
    • #3446 feat(v2): new docusaurus clear command (@abadon7)
    • #3485 feat(v2): Add @theme-init components to user theme (@edno)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages
    • #3467 feat(v2): add beforeDefaultRemarkPlugins/beforeDefaultRehypePlugins options to all md content plugins (@ayshiff)
  • docusaurus-init, docusaurus-theme-bootstrap
  • docusaurus-theme-classic
    • #3474 feat(v2): allow to use array of files in customCss field (@Simek)
  • docusaurus-plugin-content-pages, docusaurus-theme-classic
    • #3457 feat(v2): add optional custom wrapper class name for pages based on theme classic Layout (@Simek)

🐛 Bug Fix

  • Other
    • #3517 fix(v1): v1 deploy preview should be available (@slorber)
  • docusaurus
    • #3498 fix(v2): fixed props being passed to @svgr/webpack loader (@anru)
  • docusaurus-theme-search-algolia
    • #3456 fix(v2): use valid value for crossorigin attribute (@lex111)
  • docusaurus-utils
  • docusaurus-theme-classic
    • #3472 fix(v2): Show dropdown instead of a single button when there are two versions (@SamChou19815)
  • docusaurus-plugin-content-docs

💅 Polish

  • docusaurus-theme-classic
    • #3499 chore(v2): upgrade Infima to 0.2.0-alpha.13 (@lex111)

📝 Documentation

  • docusaurus
    • #3502 docs(v2): add doc for wrapping theme components with @theme-original and @theme-init (@slorber)
  • Other

🏠 Internal

  • docusaurus-1.x, docusaurus-migrate
  • Other
  • docusaurus-utils-validation

Committers: 18

2.0.0-alpha.64 (2020-09-11)

🚀 New Feature

  • docusaurus-theme-classic
    • #3432 feat(v2): add style property to theme-classic navbar (@Simek)
    • #3406 feat(v2): ability to add/override theme html metadatas (@slorber)
  • docusaurus-plugin-sitemap
    • #3426 feat(v2): add option to add trailing slash to urls in sitemap (@mpsq)

🐛 Bug Fix

  • Other
    • #3438 fix(v2): docusaurus 2 PWA should work under baseurl (deploy previews) (@slorber)
  • docusaurus-mdx-loader
  • docusaurus-plugin-pwa
  • docusaurus-theme-classic
    • #3433 fix(v2): fix theme-classic announcement bar closeable style (@Simek)
  • docusaurus-1.x
    • #3429 fix(v1): versioned_docs and skip-next-release relative path issue (@josephMG)
  • docusaurus-theme-bootstrap, docusaurus-theme-classic
    • #3418 fix(v2): reset sidebar state on sidebar changes (@slorber)
  • docusaurus-plugin-debug
    • #3405 fix(v2): fix debug plugin unscoped inline code global css (@slorber)

📝 Documentation

🏠 Internal

  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus
    • #3439 chore(v2): fix serialize-javascript security issue by upgrading webpack/workbox (@slorber)
  • Other

Committers: 7

2.0.0-alpha.63 (2020-09-03)

🚀 New Feature

  • docusaurus-types, docusaurus
    • #3387 feat(v2): allow users to specify a custom ssr HTML template (@mpsq)
  • docusaurus-plugin-debug
    • #3392 feat(v2): officially release @docusaurus/plugin-debug (@slorber)
  • docusaurus-theme-classic
    • #3388 feat(v2): add isCloseable property for theme-classic announcement bar (@Simek)
  • docusaurus-plugin-content-docs, docusaurus-theme-classic

🐛 Bug Fix

  • Other
    • #3397 fix(v2): DocSearch should keep working after a new release (part 2/2) (@slorber)
  • docusaurus-plugin-content-docs, docusaurus-theme-classic
    • #3393 fix(v2): DocSearch should keep working after a new release (part 1/2) (@slorber)
    • #3381 fix(v2): alpha 62 doc fixes (@slorber)
  • docusaurus
  • docusaurus-preset-bootstrap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus
    • #3382 fix(v2): allow using classic theme/preset without the docs plugin (@slorber)
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils-validation

📝 Documentation

🏠 Internal

  • docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-bootstrap, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils-validation, docusaurus
  • docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, 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-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-bootstrap, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils-validation, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright

Committers: 5

2.0.0-alpha.62 (2020-08-28)

🚀 New Feature

  • docusaurus-plugin-content-docs, docusaurus-theme-classic
    • #3357 feat(v2): docs version configuration: lastVersion, version.{path,label} (@slorber)
    • #3328 feat(v2): Provide docs plugin theme typing (@SamChou19815)
  • docusaurus-theme-classic
  • docusaurus-plugin-content-pages, docusaurus-theme-classic
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic
  • docusaurus-init, docusaurus-plugin-content-blog
  • docusaurus-init, docusaurus-theme-bootstrap
    • #2981 feat(v2): bootstrap theme, preset, template, CI previews (@fanny)
  • docusaurus-plugin-content-blog, docusaurus-theme-classic
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-debug, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-types, docusaurus
    • #3229 feat(v2): debug pages + debug layout + ability to debug content (@slorber)
  • docusaurus-theme-classic, docusaurus-types, docusaurus
  • docusaurus-mdx-loader, docusaurus-plugin-content-pages
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-utils-validation, docusaurus
  • docusaurus-mdx-loader
    • #3096 feat(v2): add support to import assets using relative link in markdown syntax (@anshulrgoyal)

🐛 Bug Fix

  • docusaurus-migrate
    • #3358 fix(v2): fix migrate cli paths (sidebars/customcss) (@slorber)
  • docusaurus
    • #3311 fix(v2): add https support in webpack devserver (@arcvats)
    • #3313 fix(v2): resolve webpack loaders from siteDir/node_modules (@anshulrgoyal)
    • #3308 fix(v2): brokenLinks should not report links that belong to an existing folder if folder/index.html exists (@slorber)
    • #3273 fix: logic error while deciding deploymentBranch (@thehanimo)
    • #3281 fix(v2): allow swizzling of component even if case doesn't match (@anshulrgoyal)
    • #3222 fix(v2): update react-loadable-ssr-addon to solve yarn2 error (@slorber)
    • #3191 fix(v2): add missing lodash.flatmap dependency (@ylemkimon)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-pages, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-theme-bootstrap, docusaurus-theme-search-algolia, docusaurus-types
  • docusaurus-theme-classic
    • #3352 fix(v2): Allow the alt for the logo to be empty (@Vinnl)
    • #3240 fix(v2): navbar dropdown opened with tab, not closing on click outside (@Ako92)
  • docusaurus-mdx-loader, docusaurus
    • #3347 fix(v2): linking to asset or external html page -> don't use history.push() (@slorber)
  • docusaurus-1.x
    • #3340 fix(v1): show images after one line code block (@adinaja)
  • docusaurus-1.x, docusaurus
    • #3290 fix(v1,v2): Add initial-scale=1.0 to all meta viewport tags (@nebrelbug)
  • docusaurus-theme-search-algolia
  • docusaurus-mdx-loader, docusaurus-plugin-content-pages
  • Other
  • docusaurus-plugin-google-gtag
  • docusaurus-plugin-content-docs, docusaurus-utils
    • #3262 fix(v2): doc path special char (space or other) should lead to a valid slug (@slorber)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-utils-validation, docusaurus
    • #3247 fix(v2): modify validation schema and tests for rehype/remark + remove duplicate dependency (@teikjun)
  • docusaurus-init
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus
  • docusaurus-init, docusaurus-plugin-content-docs
    • #3228 fix(v2): deprecate docs homePageId in favor of frontmatter "slug: /" (@slorber)
  • docusaurus-plugin-content-docs, docusaurus
  • docusaurus-theme-classic, docusaurus-theme-live-codeblock
    • #3210 fix(v2): fix theme validation for prism field and add tests (@teikjun)
  • docusaurus-plugin-content-docs

💅 Polish

  • docusaurus-module-type-aliases, docusaurus
    • #3244 chore(v2): tighten up the TypeScript onboarding (@orta)
  • docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils, docusaurus
  • docusaurus
    • #3188 fix(v2): Add a missing whitespace before prompt to use npm run serve (@SamChou19815)

📝 Documentation

🏠 Internal

  • docusaurus-migrate
  • docusaurus-theme-classic
    • #3343 refactor(v2): announcement bar bad spelling + minor refactors (@slorber)
  • docusaurus-plugin-content-blog
    • #3339 test(v2): make blog posts unit test ordering determinate (@BogdanDor)
  • docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-theme-classic, docusaurus-types
  • docusaurus-module-type-aliases, docusaurus
    • #3244 chore(v2): tighten up the TypeScript onboarding (@orta)
  • docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-utils, docusaurus
  • docusaurus
  • Other
  • docusaurus-1.x

🏃‍♀️ Performance

  • docusaurus-plugin-client-redirects, docusaurus-theme-search-algolia, docusaurus

Committers: 39

2.0.0-alpha.61 (2020-08-01)

🚀 New Feature

  • docusaurus-types, docusaurus
    • #3083 feat(v2): warn user when there are conflicting routes (@teikjun)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-theme-classic, docusaurus-utils-validation, docusaurus-utils
  • docusaurus-theme-classic
  • docusaurus-theme-search-algolia
  • docusaurus-plugin-content-blog, docusaurus-theme-classic
    • #2359 feat(v2): support custom description for blog-only mode (@zxuqian)

🐛 Bug Fix

  • docusaurus-mdx-loader, docusaurus
    • #3180 fix(v2): fix markdown images always using webpack url-loader (@slorber)
  • docusaurus-theme-classic
    • #3171 fix(v2): tab label showing outline & background when clicked (@mdfaizan7)
  • docusaurus-init, docusaurus-theme-classic
    • #3168 fix(v2): fix link items refusing attributes like target, rel etc... (@slorber)
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-preset-bootstrap, docusaurus-preset-classic, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus
    • #3162 fix(v2): inability for users to pin their docusaurus version (@BuckyMaler)

📝 Documentation

🏠 Internal

  • Other
  • docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, 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-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-bootstrap, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright

Committers: 8

2.0.0-alpha.60 (2020-07-29)

🚀 New Feature

  • docusaurus
  • docusaurus-1.x
    • #3124 feat(v1): add 'slugPreprocessor' config option to allow users customize the hash links (@Simek)
  • docusaurus-theme-search-algolia
    • #3133 feat(v2): add themeConfig validation to algolia theme (@slorber)

🐛 Bug Fix

  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus
    • #3142 fix(v2): config validation fixes + add tests for config validation (@teikjun)
  • docusaurus
    • #3149 fix(v2): BrowserOnly should not return undefined (@slorber)
    • #3143 fix(v2): absolute Links should be automatically prefixed by baseurl (@slorber)
  • docusaurus-plugin-content-docs, docusaurus-types, docusaurus
    • #3141 fix(v2): remove buggy routesLoaded + deprecate routesLoaded lifecycle (@slorber)
  • docusaurus-theme-classic
    • #3140 fix(v2): navbar item links should allow unknown attributes (@slorber)
  • docusaurus-theme-search-algolia
    • #3138 fix(v2): add accessible label for Algolia search button (@hobadams)
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus

📝 Documentation

🏠 Internal

  • Other
  • docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, 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-analytics, docusaurus-plugin-google-gtag, docusaurus-plugin-ideal-image, docusaurus-plugin-pwa, docusaurus-plugin-sitemap, docusaurus-preset-bootstrap, docusaurus-preset-classic, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader, stylelint-copyright

Committers: 4

2.0.0-alpha.59 (2020-07-24)

🚀 New Feature

  • docusaurus-migrate, docusaurus-plugin-client-redirects
  • docusaurus-init
  • docusaurus-theme-search-algolia
  • docusaurus-init, docusaurus-types, docusaurus
  • docusaurus-plugin-content-docs, docusaurus-utils
    • #3084 feat(v2): absolute slugs and slug resolution system (@slorber)
  • docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
    • #3069 feat(v2): support for adding relative images and handling broken image links (@anshulrgoyal)
  • docusaurus-init, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-types, docusaurus
    • #2971 feat(v2): global data + useGlobalData + docs versions dropdown (@slorber)
  • docusaurus-init, docusaurus
  • docusaurus-module-type-aliases, docusaurus-plugin-debug, docusaurus-types, docusaurus
  • docusaurus
  • docusaurus-module-type-aliases, docusaurus-plugin-debug, docusaurus
    • #3050 feat(v2): Collect plugin versions to allow them to be inspected in debug plugin (@SamChou19815)
  • docusaurus-theme-classic
    • #3038 feat(v2): Support keywords meta in blog posts (@dpkg)
    • #2974 feat(v2): Error when hooks depends on context is used outside of Layout (@SamChou19815)
  • docusaurus-plugin-pwa, docusaurus
  • docusaurus-plugin-ideal-image, docusaurus-types, docusaurus
    • #2994 feat(v2): configureWebpack merge strategy + use file-loader for common asset types (@slorber)
  • docusaurus-plugin-content-docs
    • #2989 feat(v2): add disableVersioning config to docs plugin (@slorber)
    • #2877 feat(v2): allow skipping build docs for next version (@lex111)
  • docusaurus-1.x
    • #2955 feat(v1): add deletedDocs config to fix unwanted versioning fallback (@aldeed)
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-live-codeblock, docusaurus-types, docusaurus
    • #2943 feat(v2): option and config validation life cycle method for official plugins (@anshulrgoyal)

💥 Breaking Change

  • docusaurus-init, docusaurus-module-type-aliases, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-debug, docusaurus-theme-classic, docusaurus-types, docusaurus
    • #2971 feat(v2): global data + useGlobalData + docs versions dropdown (@slorber)
  • docusaurus-theme-classic, docusaurus

🐛 Bug Fix

  • docusaurus
    • #3107 fix(v2): broken links detector: ignore existing folders (@slorber)
    • #3112 fix(v2): baseUrl is wrongly appended to anchor links (@slorber)
    • #3063 fix(v2): classify link hrefs with protocol identifier as internal (@svtfrida)
  • docusaurus-theme-classic
    • #3106 fix(v2): dropdown navbar item: validation too strict (@slorber)
    • #3029 fix(v2): change description for blog post paginator (@teikjun)
  • docusaurus-plugin-content-docs
  • docusaurus-plugin-content-pages
  • docusaurus-init
  • Other
  • docusaurus-theme-classic, docusaurus
  • docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
    • #3001 fix(v2): refactor routes.ts + add route hash for chunkNames key (@slorber)
  • docusaurus-plugin-client-redirects, docusaurus-utils, docusaurus
    • #3010 fix(v2): make client-redirect-plugin not baseUrl sensitive (@teikjun)
  • docusaurus-1.x
    • #2993 fix(relative path): last update date and by isn’t generated if localh… (@amirulahmad)
  • docusaurus-plugin-client-redirects
    • #2969 fix: fromExtensions and toExtensions translation when used with baseUrl (@jknoxville)

💅 Polish

  • docusaurus-theme-classic, docusaurus
  • docusaurus-mdx-loader
    • #3087 refactor(v2): async md image transformer + pathname protocol as an escape hatch (@slorber)
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-theme-live-codeblock, docusaurus-types
    • #2970 feat(v2): add option validation for remaining official plugins (@teikjun)
  • docusaurus

📝 Documentation

🏠 Internal

  • docusaurus-migrate
    • #3113 chore(v2): ability to test the migration cli easily (@slorber)
  • Other
  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus
  • docusaurus-mdx-loader
    • #3087 refactor(v2): async md image transformer + pathname protocol as an escape hatch (@slorber)
  • docusaurus-plugin-pwa, docusaurus
  • docusaurus-init, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-debug, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-theme-classic, docusaurus-utils, docusaurus
    • #2998 chore(v2): refactor yarn tsc to yarn build + add theme-classic watch mode (@slorber)
  • docusaurus-init
  • docusaurus-plugin-content-docs, docusaurus-utils, docusaurus
    • #3001 fix(v2): refactor routes.ts + add route hash for chunkNames key (@slorber)
  • docusaurus
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-content-pages, docusaurus-plugin-sitemap, docusaurus-theme-live-codeblock, docusaurus-types
    • #2970 feat(v2): add option validation for remaining official plugins (@teikjun)
  • docusaurus-theme-classic
  • docusaurus-plugin-client-redirects
  • docusaurus-init, docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-plugin-sitemap, docusaurus-theme-bootstrap, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus, lqip-loader
  • docusaurus-plugin-client-redirects, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-plugin-sitemap, docusaurus-utils, docusaurus, lqip-loader

Committers: 25

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
  • docusaurus-init, docusaurus
  • docusaurus-plugin-client-redirects, docusaurus-utils
  • 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
  • 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
  • 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
  • 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
  • Other
  • 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
  • docusaurus-utils
    • #2855 fix(v2): strip images and footnotes for excerpt correctly (@lex111)
  • docusaurus-theme-live-codeblock

💅 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

📝 Documentation

🏠 Internal

  • docusaurus-plugin-content-blog, docusaurus-plugin-content-docs
  • 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
  • docusaurus-theme-bootstrap
    • #2931 chore(v2): remove unused hooks from bootstrap theme (@fanny)
  • docusaurus-1.x, docusaurus-plugin-content-docs
  • docusaurus-theme-classic
    • #2858 refactor(v2): add missing main landmark for needed pages (@lex111)

🏃‍♀️ Performance

  • docusaurus-plugin-content-blog, docusaurus-plugin-sitemap
  • 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

Committers: 18

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

🚀 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
  • 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

2.0.0-alpha.55

💥 Breaking Change

  • infima

    • The following Infima classes have been renamed for consistency:

      • page-itempagination__item
      • pagination-nav__link--labelpagination-nav__label
      • pagination-nav__link--sublabelpagination-nav__sublabel
      • tab-itemtabs__item
      • tab-item--activetabs__item--active

      If you have swizzled components, you need to replace these class names.

  • docusaurus

🚀 New Feature

  • docusaurus
  • docusaurus-theme-classic
  • docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-types, docusaurus
  • docusaurus-plugin-content-docs, docusaurus-theme-search-algolia, docusaurus

🐛 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
  • 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

🏠 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

Committers: 13

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

📝 Documentation

Committers: 3

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

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
  • 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
  • docusaurus-plugin-content-blog, docusaurus-theme-classic

🐛 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
  • 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
  • docusaurus-plugin-content-docs
    • #2519 chore(v2): use single method Lodash packages in docs plugin (@Simek)

📝 Documentation

🏠 Internal

  • docusaurus-types, docusaurus
  • Other
  • 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
  • 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
  • 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

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
  • 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
  • docusaurus-plugin-content-docs, docusaurus
    • #2490 fix(v2): use lodash instead of array-map-polyfill (@lex111)

📝 Documentation

  • docusaurus-theme-classic

🏠 Internal

Committers: 5

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

🚀 New Feature

  • docusaurus-theme-classic
  • 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
  • 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
  • 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
  • docusaurus-mdx-loader
  • 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

🏠 Internal

Committers: 24

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

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
  • docusaurus-init, docusaurus-theme-classic
  • docusaurus-plugin-google-analytics, docusaurus-plugin-google-gtag, docusaurus

🐛 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
  • 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
  • Other

💅 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
  • docusaurus-types, docusaurus

📝 Documentation

🏠 Internal

  • Other
  • docusaurus-init

Committers: 16

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

HOTFIX for 2.0.0-alpha.41.

🐛 Bug Fix

  • docusaurus-theme-classic

Committers: 2

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

🚀 New Feature

  • docusaurus-init, docusaurus-preset-classic, docusaurus-theme-classic
  • docusaurus-theme-classic, docusaurus
  • 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

💥 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
  • 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
  • docusaurus-mdx-loader
  • 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

🏠 Internal

Committers: 18

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
  • docusaurus-theme-classic, docusaurus-theme-live-codeblock
    • #2114 fix(v2): add syntax highlight to generated colors (@lex111)

🏠 Internal

  • Other
  • docusaurus-init
  • docusaurus
  • 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

🏃‍♀️ Performance

Committers: 6

2.0.0-alpha.39

🐛 Bug Fix

  • docusaurus
  • 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

Committers: 1

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
  • docusaurus-plugin-ideal-image
    • #2074 fix(v2): fix plugin-ideal-image breaking website (exports not defined) (@endiliey)

💅 Polish

  • docusaurus-mdx-loader

🏠 Internal

  • docusaurus-1.x
  • 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

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

🐛 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

📝 Documentation

🏠 Internal

  • docusaurus-plugin-content-blog
  • 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
  • docusaurus-mdx-loader, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus
  • docusaurus-init, docusaurus-mdx-loader, docusaurus-plugin-content-docs, docusaurus

🏃‍♀️ 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

2.0.0-alpha.36

💥 Breaking Change

  • docusaurus-init, docusaurus-plugin-content-blog, docusaurus-theme-classic

🚀 New Feature

  • docusaurus-plugin-content-docs, docusaurus-theme-classic

🐛 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
  • Other

📝 Documentation

Committers: 3

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
  • 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
  • docusaurus-plugin-content-blog

📝 Documentation

🏠 Internal

  • Other
    • #2002 fix(v2): fix browser window menu icon on smaller screen (@lex111)
    • #1986 fix(v2): remove obsolete iframe attributes (@lex111)
  • docusaurus-init
  • docusaurus-1.x, docusaurus-init-1.x, docusaurus-init, docusaurus-plugin-content-docs, docusaurus-plugin-ideal-image, docusaurus-types, docusaurus

🏃‍♀️ Performance

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

Committers: 6

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

🏠 Internal

  • docusaurus-1.x, docusaurus-plugin-content-blog, docusaurus-plugin-content-docs, docusaurus-theme-classic, docusaurus-theme-search-algolia, docusaurus-types, docusaurus-utils, docusaurus
  • Other

🏃‍♀️ 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

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