From c60387dbe8007ed5f8cd438fdc54d738ad375198 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Fri, 3 Feb 2023 15:04:03 +0100 Subject: [PATCH] chore: backport retro compatible commits for the Docusaurus v2.3.1 release (#8621) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Joshua Chen Co-authored-by: Sébastien Castiel --- admin/new.docusaurus.io/package.json | 2 +- lerna.json | 3 +- packages/create-docusaurus/package.json | 6 ++-- .../templates/classic-typescript/package.json | 8 ++--- .../templates/classic/package.json | 8 ++--- .../templates/facebook/package.json | 6 ++-- .../docusaurus-cssnano-preset/package.json | 2 +- packages/docusaurus-logger/package.json | 2 +- packages/docusaurus-mdx-loader/package.json | 8 ++--- packages/docusaurus-migrate/package.json | 6 ++-- .../package.json | 4 +-- .../package.json | 16 +++++----- .../package.json | 16 +++++----- .../package.json | 16 +++++----- .../package.json | 12 ++++---- packages/docusaurus-plugin-debug/package.json | 8 ++--- .../package.json | 8 ++--- .../package.json | 8 ++--- .../package.json | 8 ++--- .../package.json | 14 ++++----- packages/docusaurus-plugin-pwa/package.json | 16 +++++----- .../docusaurus-plugin-sitemap/package.json | 14 ++++----- .../docusaurus-preset-classic/package.json | 28 ++++++++--------- .../docusaurus-preset-classic/src/index.ts | 7 +++-- .../package.json | 2 +- .../docusaurus-theme-classic/package.json | 26 ++++++++-------- .../src/theme/Tabs/__tests__/index.test.tsx | 12 ++++++++ .../src/theme/Tabs/index.tsx | 2 ++ packages/docusaurus-theme-common/package.json | 18 +++++------ .../src/utils/historyUtils.ts | 6 +++- .../src/utils/scrollUtils.tsx | 5 +++- .../src/utils/storageUtils.ts | 7 +++++ .../src/utils/tabsUtils.tsx | 10 +++++-- .../package.json | 12 ++++---- .../docusaurus-theme-mermaid/package.json | 12 ++++---- .../package.json | 20 ++++++------- .../locales/zh-Hans/theme-common.json | 4 +-- .../locales/zh-Hant/theme-common.json | 4 +-- .../package.json | 6 ++-- packages/docusaurus-types/package.json | 2 +- packages/docusaurus-utils-common/package.json | 2 +- .../docusaurus-utils-validation/package.json | 6 ++-- packages/docusaurus-utils/package.json | 6 ++-- .../src/__tests__/markdownUtils.test.ts | 20 +++++++++++++ .../docusaurus-utils/src/markdownUtils.ts | 8 +++-- packages/docusaurus/package.json | 20 ++++++------- packages/eslint-plugin/package.json | 2 +- packages/lqip-loader/package.json | 4 +-- packages/stylelint-copyright/package.json | 2 +- .../_dogfooding/_pages tests/tabs-tests.mdx | 26 ++++++++++++++++ website/package.json | 30 +++++++++---------- yarn.lock | 8 ++--- 52 files changed, 296 insertions(+), 212 deletions(-) diff --git a/admin/new.docusaurus.io/package.json b/admin/new.docusaurus.io/package.json index de550ea913..2a30ef8bda 100644 --- a/admin/new.docusaurus.io/package.json +++ b/admin/new.docusaurus.io/package.json @@ -1,6 +1,6 @@ { "name": "new.docusaurus.io", - "version": "2.3.0", + "version": "2.3.1", "private": true, "scripts": { "start": "npx --package netlify-cli netlify dev" diff --git a/lerna.json b/lerna.json index d7b1554f60..2c27934e86 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "2.3.0", + "version": "2.3.1", "npmClient": "yarn", "useWorkspaces": true, "changelog": { @@ -11,6 +11,7 @@ "pr: performance": ":running_woman: Performance", "pr: polish": ":nail_care: Polish", "pr: documentation": ":memo: Documentation", + "pr: dependencies": ":robot: Dependencies", "pr: maintenance": ":wrench: Maintenance" }, "cacheDir": ".changelog" diff --git a/packages/create-docusaurus/package.json b/packages/create-docusaurus/package.json index 3b6eda6086..1e0e270f08 100755 --- a/packages/create-docusaurus/package.json +++ b/packages/create-docusaurus/package.json @@ -1,6 +1,6 @@ { "name": "create-docusaurus", - "version": "2.3.0", + "version": "2.3.1", "description": "Create Docusaurus apps easily.", "type": "module", "repository": { @@ -22,8 +22,8 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.3.0", - "@docusaurus/utils": "2.3.0", + "@docusaurus/logger": "2.3.1", + "@docusaurus/utils": "2.3.1", "commander": "^5.1.0", "fs-extra": "^10.1.0", "lodash": "^4.17.21", diff --git a/packages/create-docusaurus/templates/classic-typescript/package.json b/packages/create-docusaurus/templates/classic-typescript/package.json index e3c37260e6..418bbddf8c 100644 --- a/packages/create-docusaurus/templates/classic-typescript/package.json +++ b/packages/create-docusaurus/templates/classic-typescript/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-classic-typescript-template", - "version": "2.3.0", + "version": "2.3.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,8 +15,8 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/preset-classic": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/preset-classic": "2.3.1", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1", "prism-react-renderer": "^1.3.5", @@ -24,7 +24,7 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.3.0", + "@docusaurus/module-type-aliases": "2.3.1", "@tsconfig/docusaurus": "^1.0.5", "typescript": "^4.7.4" }, diff --git a/packages/create-docusaurus/templates/classic/package.json b/packages/create-docusaurus/templates/classic/package.json index 3c423a60d4..c792154ba0 100644 --- a/packages/create-docusaurus/templates/classic/package.json +++ b/packages/create-docusaurus/templates/classic/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-classic-template", - "version": "2.3.0", + "version": "2.3.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -14,8 +14,8 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/preset-classic": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/preset-classic": "2.3.1", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1", "prism-react-renderer": "^1.3.5", @@ -23,7 +23,7 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.3.0" + "@docusaurus/module-type-aliases": "2.3.1" }, "browserslist": { "production": [ diff --git a/packages/create-docusaurus/templates/facebook/package.json b/packages/create-docusaurus/templates/facebook/package.json index e1e04e6407..e70f7b017b 100644 --- a/packages/create-docusaurus/templates/facebook/package.json +++ b/packages/create-docusaurus/templates/facebook/package.json @@ -1,6 +1,6 @@ { "name": "docusaurus-2-facebook-template", - "version": "2.3.0", + "version": "2.3.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -18,8 +18,8 @@ "format:diff": "prettier --config .prettierrc --list-different \"**/*.{js,jsx,ts,tsx,md,mdx}\"" }, "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/preset-classic": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/preset-classic": "2.3.1", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1", "react": "^17.0.2", diff --git a/packages/docusaurus-cssnano-preset/package.json b/packages/docusaurus-cssnano-preset/package.json index 60942313aa..67f64b46b3 100644 --- a/packages/docusaurus-cssnano-preset/package.json +++ b/packages/docusaurus-cssnano-preset/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/cssnano-preset", - "version": "2.3.0", + "version": "2.3.1", "description": "Advanced cssnano preset for maximum optimization.", "main": "lib/index.js", "license": "MIT", diff --git a/packages/docusaurus-logger/package.json b/packages/docusaurus-logger/package.json index 2a59bc1d04..ef1cfeb8c2 100644 --- a/packages/docusaurus-logger/package.json +++ b/packages/docusaurus-logger/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/logger", - "version": "2.3.0", + "version": "2.3.1", "description": "An encapsulated logger for semantically formatting console messages.", "main": "./lib/index.js", "repository": { diff --git a/packages/docusaurus-mdx-loader/package.json b/packages/docusaurus-mdx-loader/package.json index 5dd0400b3f..15f6f49ba3 100644 --- a/packages/docusaurus-mdx-loader/package.json +++ b/packages/docusaurus-mdx-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/mdx-loader", - "version": "2.3.0", + "version": "2.3.1", "description": "Docusaurus Loader for MDX", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -20,8 +20,8 @@ "dependencies": { "@babel/parser": "^7.18.8", "@babel/traverse": "^7.18.8", - "@docusaurus/logger": "2.3.0", - "@docusaurus/utils": "2.3.0", + "@docusaurus/logger": "2.3.1", + "@docusaurus/utils": "2.3.1", "@mdx-js/mdx": "^1.6.22", "escape-html": "^1.0.3", "file-loader": "^6.2.0", @@ -37,7 +37,7 @@ "webpack": "^5.73.0" }, "devDependencies": { - "@docusaurus/types": "2.3.0", + "@docusaurus/types": "2.3.1", "@types/escape-html": "^1.0.2", "@types/mdast": "^3.0.10", "@types/stringify-object": "^3.3.1", diff --git a/packages/docusaurus-migrate/package.json b/packages/docusaurus-migrate/package.json index c779e95fcf..b99c886aae 100644 --- a/packages/docusaurus-migrate/package.json +++ b/packages/docusaurus-migrate/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/migrate", - "version": "2.3.0", + "version": "2.3.1", "description": "A CLI tool to migrate from older versions of Docusaurus.", "license": "MIT", "engines": { @@ -24,8 +24,8 @@ "dependencies": { "@babel/core": "^7.18.6", "@babel/preset-env": "^7.18.6", - "@docusaurus/logger": "2.3.0", - "@docusaurus/utils": "2.3.0", + "@docusaurus/logger": "2.3.1", + "@docusaurus/utils": "2.3.1", "@mapbox/hast-util-to-jsx": "^2.0.0", "color": "^4.2.3", "commander": "^5.1.0", diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json index 679e22faa6..e3d23c030a 100644 --- a/packages/docusaurus-module-type-aliases/package.json +++ b/packages/docusaurus-module-type-aliases/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/module-type-aliases", - "version": "2.3.0", + "version": "2.3.1", "description": "Docusaurus module type aliases.", "types": "./src/index.d.ts", "publishConfig": { @@ -13,7 +13,7 @@ }, "dependencies": { "@docusaurus/react-loadable": "5.5.2", - "@docusaurus/types": "2.3.0", + "@docusaurus/types": "2.3.1", "@types/history": "^4.7.11", "@types/react": "*", "@types/react-router-config": "*", diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json index 877190e413..b3f2db9e68 100644 --- a/packages/docusaurus-plugin-client-redirects/package.json +++ b/packages/docusaurus-plugin-client-redirects/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-client-redirects", - "version": "2.3.0", + "version": "2.3.1", "description": "Client redirects plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,18 +18,18 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/logger": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-common": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", - "eta": "^1.12.3", + "@docusaurus/core": "2.3.1", + "@docusaurus/logger": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-common": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", + "eta": "^2.0.0", "fs-extra": "^10.1.0", "lodash": "^4.17.21", "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.3.0" + "@docusaurus/types": "2.3.1" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json index 3f94945db8..92ce58e7f9 100644 --- a/packages/docusaurus-plugin-content-blog/package.json +++ b/packages/docusaurus-plugin-content-blog/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-blog", - "version": "2.3.0", + "version": "2.3.1", "description": "Blog plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-blog.d.ts", @@ -18,13 +18,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/logger": "2.3.0", - "@docusaurus/mdx-loader": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-common": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/logger": "2.3.1", + "@docusaurus/mdx-loader": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-common": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "cheerio": "^1.0.0-rc.12", "feed": "^4.2.2", "fs-extra": "^10.1.0", diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json index b60bb1e76c..ef9f23b644 100644 --- a/packages/docusaurus-plugin-content-docs/package.json +++ b/packages/docusaurus-plugin-content-docs/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-docs", - "version": "2.3.0", + "version": "2.3.1", "description": "Docs plugin for Docusaurus.", "main": "lib/index.js", "sideEffects": false, @@ -35,13 +35,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/logger": "2.3.0", - "@docusaurus/mdx-loader": "2.3.0", - "@docusaurus/module-type-aliases": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/logger": "2.3.1", + "@docusaurus/mdx-loader": "2.3.1", + "@docusaurus/module-type-aliases": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "@types/react-router-config": "^5.0.6", "combine-promises": "^1.1.0", "fs-extra": "^10.1.0", diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json index 59e1da61ca..0c9f0146f0 100644 --- a/packages/docusaurus-plugin-content-pages/package.json +++ b/packages/docusaurus-plugin-content-pages/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-content-pages", - "version": "2.3.0", + "version": "2.3.1", "description": "Pages plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-pages.d.ts", @@ -18,11 +18,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/mdx-loader": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/mdx-loader": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "fs-extra": "^10.1.0", "tslib": "^2.4.0", "webpack": "^5.73.0" diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json index 418e6e0284..f76580c784 100644 --- a/packages/docusaurus-plugin-debug/package.json +++ b/packages/docusaurus-plugin-debug/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-debug", - "version": "2.3.0", + "version": "2.3.1", "description": "Debug plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-debug.d.ts", @@ -20,9 +20,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils": "2.3.1", "fs-extra": "^10.1.0", "react-json-view": "^1.21.3", "tslib": "^2.4.0" diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json index 814f08b985..002e5cb638 100644 --- a/packages/docusaurus-plugin-google-analytics/package.json +++ b/packages/docusaurus-plugin-google-analytics/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-analytics", - "version": "2.3.0", + "version": "2.3.1", "description": "Global analytics (analytics.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "tslib": "^2.4.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json index cb5c9a1b8b..cd32f819a0 100644 --- a/packages/docusaurus-plugin-google-gtag/package.json +++ b/packages/docusaurus-plugin-google-gtag/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-gtag", - "version": "2.3.0", + "version": "2.3.1", "description": "Global Site Tag (gtag.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "tslib": "^2.4.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-google-tag-manager/package.json b/packages/docusaurus-plugin-google-tag-manager/package.json index 41b8a32764..feeeb85292 100644 --- a/packages/docusaurus-plugin-google-tag-manager/package.json +++ b/packages/docusaurus-plugin-google-tag-manager/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-google-tag-manager", - "version": "2.3.0", + "version": "2.3.1", "description": "Google Tag Manager (gtm.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,9 +18,9 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "tslib": "^2.4.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json index fb7371b834..1cfd377565 100644 --- a/packages/docusaurus-plugin-ideal-image/package.json +++ b/packages/docusaurus-plugin-ideal-image/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-ideal-image", - "version": "2.3.0", + "version": "2.3.1", "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).", "main": "lib/index.js", "types": "src/plugin-ideal-image.d.ts", @@ -20,12 +20,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/lqip-loader": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/lqip-loader": "2.3.1", "@docusaurus/responsive-loader": "^1.7.0", - "@docusaurus/theme-translations": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/theme-translations": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "@endiliey/react-ideal-image": "^0.0.11", "react-waypoint": "^10.3.0", "sharp": "^0.30.7", @@ -33,7 +33,7 @@ "webpack": "^5.73.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.3.0", + "@docusaurus/module-type-aliases": "2.3.1", "fs-extra": "^10.1.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json index 64a9dabf5e..0f1e318f2a 100644 --- a/packages/docusaurus-plugin-pwa/package.json +++ b/packages/docusaurus-plugin-pwa/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-pwa", - "version": "2.3.0", + "version": "2.3.1", "description": "Docusaurus Plugin to add PWA support.", "main": "lib/index.js", "types": "src/plugin-pwa.d.ts", @@ -22,12 +22,12 @@ "dependencies": { "@babel/core": "^7.18.6", "@babel/preset-env": "^7.18.6", - "@docusaurus/core": "2.3.0", - "@docusaurus/theme-common": "2.3.0", - "@docusaurus/theme-translations": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/theme-common": "2.3.1", + "@docusaurus/theme-translations": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "babel-loader": "^8.2.5", "clsx": "^1.2.1", "core-js": "^3.23.3", @@ -40,7 +40,7 @@ "workbox-window": "^6.5.3" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.3.0", + "@docusaurus/module-type-aliases": "2.3.1", "fs-extra": "^10.1.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index d782d741e8..a3f9ec2a48 100644 --- a/packages/docusaurus-plugin-sitemap/package.json +++ b/packages/docusaurus-plugin-sitemap/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-sitemap", - "version": "2.3.0", + "version": "2.3.1", "description": "Simple sitemap generation plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/logger": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-common": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/logger": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-common": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "fs-extra": "^10.1.0", "sitemap": "^7.1.1", "tslib": "^2.4.0" diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index a6f0a08633..fde5fe41cb 100644 --- a/packages/docusaurus-preset-classic/package.json +++ b/packages/docusaurus-preset-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/preset-classic", - "version": "2.3.0", + "version": "2.3.1", "description": "Classic preset for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,19 +18,19 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/plugin-content-blog": "2.3.0", - "@docusaurus/plugin-content-docs": "2.3.0", - "@docusaurus/plugin-content-pages": "2.3.0", - "@docusaurus/plugin-debug": "2.3.0", - "@docusaurus/plugin-google-analytics": "2.3.0", - "@docusaurus/plugin-google-gtag": "2.3.0", - "@docusaurus/plugin-google-tag-manager": "2.3.0", - "@docusaurus/plugin-sitemap": "2.3.0", - "@docusaurus/theme-classic": "2.3.0", - "@docusaurus/theme-common": "2.3.0", - "@docusaurus/theme-search-algolia": "2.3.0", - "@docusaurus/types": "2.3.0" + "@docusaurus/core": "2.3.1", + "@docusaurus/plugin-content-blog": "2.3.1", + "@docusaurus/plugin-content-docs": "2.3.1", + "@docusaurus/plugin-content-pages": "2.3.1", + "@docusaurus/plugin-debug": "2.3.1", + "@docusaurus/plugin-google-analytics": "2.3.1", + "@docusaurus/plugin-google-gtag": "2.3.1", + "@docusaurus/plugin-google-tag-manager": "2.3.1", + "@docusaurus/plugin-sitemap": "2.3.1", + "@docusaurus/theme-classic": "2.3.1", + "@docusaurus/theme-common": "2.3.1", + "@docusaurus/theme-search-algolia": "2.3.1", + "@docusaurus/types": "2.3.1" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-preset-classic/src/index.ts b/packages/docusaurus-preset-classic/src/index.ts index c1cc099c39..ff4f70602a 100644 --- a/packages/docusaurus-preset-classic/src/index.ts +++ b/packages/docusaurus-preset-classic/src/index.ts @@ -83,7 +83,10 @@ export default function preset( } if (googleTagManager) { plugins.push( - makePluginConfig('@docusaurus/plugin-google-gtag', googleTagManager), + makePluginConfig( + '@docusaurus/plugin-google-tag-manager', + googleTagManager, + ), ); } if (isProd && sitemap !== false) { @@ -93,7 +96,7 @@ export default function preset( throw new Error( `Unrecognized keys ${Object.keys(rest).join( ', ', - )} found in preset-classic configuration. The allowed keys are debug, docs, blog, pages, sitemap, theme, googleAnalytics, gtag. Check the documentation: https://docusaurus.io/docs/using-plugins#docusauruspreset-classic for more information on how to configure individual plugins.`, + )} found in preset-classic configuration. The allowed keys are debug, docs, blog, pages, sitemap, theme, googleAnalytics, gtag, and googleTagManager. Check the documentation: https://docusaurus.io/docs/using-plugins#docusauruspreset-classic for more information on how to configure individual plugins.`, ); } diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json index fe38341730..a8b1829eac 100644 --- a/packages/docusaurus-remark-plugin-npm2yarn/package.json +++ b/packages/docusaurus-remark-plugin-npm2yarn/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/remark-plugin-npm2yarn", - "version": "2.3.0", + "version": "2.3.1", "description": "Remark plugin for converting npm commands to Yarn commands as tabs.", "main": "lib/index.js", "publishConfig": { diff --git a/packages/docusaurus-theme-classic/package.json b/packages/docusaurus-theme-classic/package.json index 24503d0632..0674e4c302 100644 --- a/packages/docusaurus-theme-classic/package.json +++ b/packages/docusaurus-theme-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-classic", - "version": "2.3.0", + "version": "2.3.1", "description": "Classic theme for Docusaurus", "main": "lib/index.js", "types": "src/theme-classic.d.ts", @@ -20,18 +20,18 @@ "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch" }, "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/mdx-loader": "2.3.0", - "@docusaurus/module-type-aliases": "2.3.0", - "@docusaurus/plugin-content-blog": "2.3.0", - "@docusaurus/plugin-content-docs": "2.3.0", - "@docusaurus/plugin-content-pages": "2.3.0", - "@docusaurus/theme-common": "2.3.0", - "@docusaurus/theme-translations": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-common": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/mdx-loader": "2.3.1", + "@docusaurus/module-type-aliases": "2.3.1", + "@docusaurus/plugin-content-blog": "2.3.1", + "@docusaurus/plugin-content-docs": "2.3.1", + "@docusaurus/plugin-content-pages": "2.3.1", + "@docusaurus/theme-common": "2.3.1", + "@docusaurus/theme-translations": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-common": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "@mdx-js/react": "^1.6.22", "clsx": "^1.2.1", "copy-text-to-clipboard": "^3.0.1", diff --git a/packages/docusaurus-theme-classic/src/theme/Tabs/__tests__/index.test.tsx b/packages/docusaurus-theme-classic/src/theme/Tabs/__tests__/index.test.tsx index f4d59c7409..90f150b6ef 100644 --- a/packages/docusaurus-theme-classic/src/theme/Tabs/__tests__/index.test.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Tabs/__tests__/index.test.tsx @@ -187,4 +187,16 @@ describe('Tabs', () => { ); }).not.toThrow(); }); + + it('accepts a single TabItem', () => { + expect(() => { + renderer.create( + + + Val1 + + , + ); + }).not.toThrow(); + }); }); diff --git a/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx b/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx index 59103c8d07..e989d082a5 100644 --- a/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx +++ b/packages/docusaurus-theme-classic/src/theme/Tabs/index.tsx @@ -109,6 +109,8 @@ function TabContent({ children, selectedValue, }: Props & ReturnType) { + // eslint-disable-next-line no-param-reassign + children = Array.isArray(children) ? children : [children]; if (lazy) { const selectedTabItem = children.find( (tabItem) => tabItem.props.value === selectedValue, diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json index 3fc7a9ab25..228b473d24 100644 --- a/packages/docusaurus-theme-common/package.json +++ b/packages/docusaurus-theme-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-common", - "version": "2.3.0", + "version": "2.3.1", "description": "Common code for Docusaurus themes.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -30,12 +30,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/mdx-loader": "2.3.0", - "@docusaurus/module-type-aliases": "2.3.0", - "@docusaurus/plugin-content-blog": "2.3.0", - "@docusaurus/plugin-content-docs": "2.3.0", - "@docusaurus/plugin-content-pages": "2.3.0", - "@docusaurus/utils": "2.3.0", + "@docusaurus/mdx-loader": "2.3.1", + "@docusaurus/module-type-aliases": "2.3.1", + "@docusaurus/plugin-content-blog": "2.3.1", + "@docusaurus/plugin-content-docs": "2.3.1", + "@docusaurus/plugin-content-pages": "2.3.1", + "@docusaurus/utils": "2.3.1", "@types/history": "^4.7.11", "@types/react": "*", "@types/react-router-config": "*", @@ -47,8 +47,8 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/types": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/types": "2.3.1", "fs-extra": "^10.1.0", "lodash": "^4.17.21" }, diff --git a/packages/docusaurus-theme-common/src/utils/historyUtils.ts b/packages/docusaurus-theme-common/src/utils/historyUtils.ts index a81663feac..06b124a229 100644 --- a/packages/docusaurus-theme-common/src/utils/historyUtils.ts +++ b/packages/docusaurus-theme-common/src/utils/historyUtils.ts @@ -56,7 +56,11 @@ export function useHistorySelector( selector: (history: History) => Value, ): Value { const history = useHistory(); - return useSyncExternalStore(history.listen, () => selector(history)); + return useSyncExternalStore( + history.listen, + () => selector(history), + () => selector(history), + ); } /** diff --git a/packages/docusaurus-theme-common/src/utils/scrollUtils.tsx b/packages/docusaurus-theme-common/src/utils/scrollUtils.tsx index 8d530ed48a..78e68a04b1 100644 --- a/packages/docusaurus-theme-common/src/utils/scrollUtils.tsx +++ b/packages/docusaurus-theme-common/src/utils/scrollUtils.tsx @@ -222,7 +222,10 @@ export function useScrollPositionBlocker(): { ); useLayoutEffect(() => { - nextLayoutEffectCallbackRef.current?.(); + // Queuing permits to restore scroll position after all useLayoutEffect + // have run, and yet preserve the sync nature of the scroll restoration + // See https://github.com/facebook/docusaurus/issues/8625 + queueMicrotask(() => nextLayoutEffectCallbackRef.current?.()); }); return { diff --git a/packages/docusaurus-theme-common/src/utils/storageUtils.ts b/packages/docusaurus-theme-common/src/utils/storageUtils.ts index c668cfaa4f..dacfa1632b 100644 --- a/packages/docusaurus-theme-common/src/utils/storageUtils.ts +++ b/packages/docusaurus-theme-common/src/utils/storageUtils.ts @@ -31,6 +31,13 @@ function dispatchChangeEvent({ newValue: string | null; storage: Storage; }) { + // If we set multiple times the same storage value, events should not be fired + // The native events behave this way, so our manual event dispatch should + // rather behave exactly the same. Not doing so might create infinite loops. + // See https://github.com/facebook/docusaurus/issues/8594 + if (oldValue === newValue) { + return; + } const event = document.createEvent('StorageEvent'); event.initStorageEvent( 'storage', diff --git a/packages/docusaurus-theme-common/src/utils/tabsUtils.tsx b/packages/docusaurus-theme-common/src/utils/tabsUtils.tsx index 403e023ef4..64b3d6446e 100644 --- a/packages/docusaurus-theme-common/src/utils/tabsUtils.tsx +++ b/packages/docusaurus-theme-common/src/utils/tabsUtils.tsx @@ -8,11 +8,11 @@ import React, { isValidElement, useCallback, - useEffect, useState, useMemo, type ReactNode, type ReactElement, + useLayoutEffect, } from 'react'; import {useHistory} from '@docusaurus/router'; import {useQueryStringValue} from '@docusaurus/theme-common/internal'; @@ -32,7 +32,9 @@ export interface TabValue { export interface TabsProps { readonly lazy?: boolean; readonly block?: boolean; - readonly children: readonly ReactElement[]; + readonly children: + | readonly ReactElement[] + | ReactElement; readonly defaultValue?: string | null; readonly values?: readonly TabValue[]; readonly groupId?: string; @@ -244,7 +246,9 @@ export function useTabs(props: TabsProps): { } return value; })(); - useEffect(() => { + // Sync in a layout/sync effect is important, for useScrollPositionBlocker + // See https://github.com/facebook/docusaurus/issues/8625 + useLayoutEffect(() => { if (valueToSync) { setSelectedValue(valueToSync); } diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json index fa06ef12c7..7f02b529c1 100644 --- a/packages/docusaurus-theme-live-codeblock/package.json +++ b/packages/docusaurus-theme-live-codeblock/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-live-codeblock", - "version": "2.3.0", + "version": "2.3.1", "description": "Docusaurus live code block component.", "main": "lib/index.js", "types": "src/theme-live-codeblock.d.ts", @@ -23,10 +23,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/theme-common": "2.3.0", - "@docusaurus/theme-translations": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/theme-common": "2.3.1", + "@docusaurus/theme-translations": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "@philpl/buble": "^0.19.7", "clsx": "^1.2.1", "fs-extra": "^10.1.0", @@ -34,7 +34,7 @@ "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.3.0", + "@docusaurus/types": "2.3.1", "@types/buble": "^0.20.1" }, "peerDependencies": { diff --git a/packages/docusaurus-theme-mermaid/package.json b/packages/docusaurus-theme-mermaid/package.json index 81cf1d45b1..a3cf3b0c1a 100644 --- a/packages/docusaurus-theme-mermaid/package.json +++ b/packages/docusaurus-theme-mermaid/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-mermaid", - "version": "2.3.0", + "version": "2.3.1", "description": "Mermaid components for Docusaurus.", "main": "lib/index.js", "types": "src/theme-mermaid.d.ts", @@ -33,11 +33,11 @@ "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch" }, "dependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/module-type-aliases": "2.3.0", - "@docusaurus/theme-common": "2.3.0", - "@docusaurus/types": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/module-type-aliases": "2.3.1", + "@docusaurus/theme-common": "2.3.1", + "@docusaurus/types": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "@mdx-js/react": "^1.6.22", "mermaid": "^9.2.2", "tslib": "^2.4.0" diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json index 3ece9b51bf..0090458762 100644 --- a/packages/docusaurus-theme-search-algolia/package.json +++ b/packages/docusaurus-theme-search-algolia/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-search-algolia", - "version": "2.3.0", + "version": "2.3.1", "description": "Algolia search component for Docusaurus.", "main": "lib/index.js", "sideEffects": [ @@ -34,24 +34,24 @@ }, "dependencies": { "@docsearch/react": "^3.1.1", - "@docusaurus/core": "2.3.0", - "@docusaurus/logger": "2.3.0", - "@docusaurus/plugin-content-docs": "2.3.0", - "@docusaurus/theme-common": "2.3.0", - "@docusaurus/theme-translations": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/logger": "2.3.1", + "@docusaurus/plugin-content-docs": "2.3.1", + "@docusaurus/theme-common": "2.3.1", + "@docusaurus/theme-translations": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "algoliasearch": "^4.13.1", "algoliasearch-helper": "^3.10.0", "clsx": "^1.2.1", - "eta": "^1.12.3", + "eta": "^2.0.0", "fs-extra": "^10.1.0", "lodash": "^4.17.21", "tslib": "^2.4.0", "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.3.0" + "@docusaurus/module-type-aliases": "2.3.1" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json b/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json index 80d298d961..30bff75c75 100644 --- a/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/zh-Hans/theme-common.json @@ -8,7 +8,7 @@ "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": "打开/收起侧边栏菜单「{label}」", "theme.ErrorPageContent.title": "页面已崩溃。", "theme.ErrorPageContent.tryAgain": "重试", - "theme.NavBar.navAriaLabel": "Main", + "theme.NavBar.navAriaLabel": "主导航", "theme.NotFound.p1": "我们找不到您要找的页面。", "theme.NotFound.p2": "请联系原始链接来源网站的所有者,并告知他们链接已损坏。", "theme.NotFound.title": "找不到页面", @@ -49,7 +49,7 @@ "theme.docs.sidebar.collapseButtonTitle": "收起侧边栏", "theme.docs.sidebar.expandButtonAriaLabel": "展开侧边栏", "theme.docs.sidebar.expandButtonTitle": "展开侧边栏", - "theme.docs.sidebar.navAriaLabel": "Docs sidebar", + "theme.docs.sidebar.navAriaLabel": "文档侧边栏", "theme.docs.sidebar.toggleSidebarButtonAriaLabel": "切换导航栏", "theme.docs.tagDocListPageTitle": "{nDocsTagged}「{tagName}」", "theme.docs.tagDocListPageTitle.nDocsTagged": "{count} 篇文档带有标签", diff --git a/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json b/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json index 1e422f0efc..ee8ec70b61 100644 --- a/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json +++ b/packages/docusaurus-theme-translations/locales/zh-Hant/theme-common.json @@ -8,7 +8,7 @@ "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": "打開/收起側邊欄選單「{label}」", "theme.ErrorPageContent.title": "此頁已當機。", "theme.ErrorPageContent.tryAgain": "重試", - "theme.NavBar.navAriaLabel": "Main", + "theme.NavBar.navAriaLabel": "主導航", "theme.NotFound.p1": "我們沒有您要找的頁面。", "theme.NotFound.p2": "請聯絡原始連結來源網站的所有者,並通知他們連結已毀損。", "theme.NotFound.title": "找不到頁面", @@ -49,7 +49,7 @@ "theme.docs.sidebar.collapseButtonTitle": "收起側邊欄", "theme.docs.sidebar.expandButtonAriaLabel": "展開側邊欄", "theme.docs.sidebar.expandButtonTitle": "展開側邊欄", - "theme.docs.sidebar.navAriaLabel": "Docs sidebar", + "theme.docs.sidebar.navAriaLabel": "文件側邊欄", "theme.docs.sidebar.toggleSidebarButtonAriaLabel": "Toggle navigation bar", "theme.docs.tagDocListPageTitle": "{nDocsTagged}「{tagName}」", "theme.docs.tagDocListPageTitle.nDocsTagged": "{count} 篇文件帶有標籤", diff --git a/packages/docusaurus-theme-translations/package.json b/packages/docusaurus-theme-translations/package.json index e59e99e0e2..de7e6d8146 100644 --- a/packages/docusaurus-theme-translations/package.json +++ b/packages/docusaurus-theme-translations/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-translations", - "version": "2.3.0", + "version": "2.3.1", "description": "Docusaurus theme translations.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -23,8 +23,8 @@ "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/core": "2.3.0", - "@docusaurus/logger": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/logger": "2.3.1", "lodash": "^4.17.21" }, "engines": { diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json index 040454499b..41d47ad459 100644 --- a/packages/docusaurus-types/package.json +++ b/packages/docusaurus-types/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/types", - "version": "2.3.0", + "version": "2.3.1", "description": "Common types for Docusaurus packages.", "types": "./src/index.d.ts", "publishConfig": { diff --git a/packages/docusaurus-utils-common/package.json b/packages/docusaurus-utils-common/package.json index 320d6683b7..62620141e0 100644 --- a/packages/docusaurus-utils-common/package.json +++ b/packages/docusaurus-utils-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-common", - "version": "2.3.0", + "version": "2.3.1", "description": "Common (Node/Browser) utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json index e5e3ece565..34816ef406 100644 --- a/packages/docusaurus-utils-validation/package.json +++ b/packages/docusaurus-utils-validation/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-validation", - "version": "2.3.0", + "version": "2.3.1", "description": "Node validation utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,8 +18,8 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.3.0", - "@docusaurus/utils": "2.3.0", + "@docusaurus/logger": "2.3.1", + "@docusaurus/utils": "2.3.1", "joi": "^17.6.0", "js-yaml": "^4.1.0", "tslib": "^2.4.0" diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json index fc3eb8096b..c5009ad2ea 100644 --- a/packages/docusaurus-utils/package.json +++ b/packages/docusaurus-utils/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils", - "version": "2.3.0", + "version": "2.3.1", "description": "Node utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -18,7 +18,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.3.0", + "@docusaurus/logger": "2.3.1", "@svgr/webpack": "^6.2.1", "escape-string-regexp": "^4.0.0", "file-loader": "^6.2.0", @@ -39,7 +39,7 @@ "node": ">=16.14" }, "devDependencies": { - "@docusaurus/types": "2.3.0", + "@docusaurus/types": "2.3.1", "@types/dedent": "^0.7.0", "@types/github-slugger": "^1.3.0", "@types/micromatch": "^4.0.2", diff --git a/packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts b/packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts index 579c47e826..014709f4df 100644 --- a/packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts +++ b/packages/docusaurus-utils/src/__tests__/markdownUtils.test.ts @@ -130,6 +130,26 @@ describe('createExcerpt', () => { ); }); + it('creates excerpt for content with imports/exports declarations, with CRLF line endings', () => { + expect( + createExcerpt( + dedent` + import Component from '@site/src/components/Component'; + + export function ItemCol(props) { + return + } + + Lorem **ipsum** dolor sit \`amet\`[^1], consectetur _adipiscing_ elit. [**Vestibulum**](https://wiktionary.org/wiki/vestibulum) ex urna[^note], ~~molestie~~ et sagittis ut, varius ac justo :wink:. + + Nunc porttitor libero nec vulputate venenatis. Nam nec rhoncus mauris. Morbi tempus est et nibh maximus, tempus venenatis arcu lobortis. + `.replace(/\n/g, '\r\n'), + ), + ).toBe( + 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum ex urna, molestie et sagittis ut, varius ac justo.', + ); + }); + it('creates excerpt for heading specified with anchor-id syntax', () => { expect( createExcerpt(dedent` diff --git a/packages/docusaurus-utils/src/markdownUtils.ts b/packages/docusaurus-utils/src/markdownUtils.ts index f97638a49d..fb395a02c2 100644 --- a/packages/docusaurus-utils/src/markdownUtils.ts +++ b/packages/docusaurus-utils/src/markdownUtils.ts @@ -55,16 +55,18 @@ export function createExcerpt(fileString: string): string | undefined { const fileLines = fileString .trimStart() // Remove Markdown alternate title - .replace(/^[^\n]*\n[=]+/g, '') - .split('\n'); + .replace(/^[^\r\n]*\r?\n[=]+/g, '') + .split(/\r?\n/); let inCode = false; let inImport = false; let lastCodeFence = ''; for (const fileLine of fileLines) { - if (fileLine === '' && inImport) { + // An empty line marks the end of imports + if (!fileLine.trim() && inImport) { inImport = false; } + // Skip empty line. if (!fileLine.trim()) { continue; diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json index c9a887ac7d..5ef2262daa 100644 --- a/packages/docusaurus/package.json +++ b/packages/docusaurus/package.json @@ -1,7 +1,7 @@ { "name": "@docusaurus/core", "description": "Easy to Maintain Open Source Documentation Websites", - "version": "2.3.0", + "version": "2.3.1", "license": "MIT", "publishConfig": { "access": "public" @@ -43,13 +43,13 @@ "@babel/runtime": "^7.18.6", "@babel/runtime-corejs3": "^7.18.6", "@babel/traverse": "^7.18.8", - "@docusaurus/cssnano-preset": "2.3.0", - "@docusaurus/logger": "2.3.0", - "@docusaurus/mdx-loader": "2.3.0", + "@docusaurus/cssnano-preset": "2.3.1", + "@docusaurus/logger": "2.3.1", + "@docusaurus/mdx-loader": "2.3.1", "@docusaurus/react-loadable": "5.5.2", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-common": "2.3.0", - "@docusaurus/utils-validation": "2.3.0", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-common": "2.3.1", + "@docusaurus/utils-validation": "2.3.1", "@slorber/static-site-generator-webpack-plugin": "^4.0.7", "@svgr/webpack": "^6.2.1", "autoprefixer": "^10.4.7", @@ -70,7 +70,7 @@ "del": "^6.1.1", "detect-port": "^1.3.0", "escape-html": "^1.0.3", - "eta": "^1.12.3", + "eta": "^2.0.0", "file-loader": "^6.2.0", "fs-extra": "^10.1.0", "html-minifier-terser": "^6.1.0", @@ -106,8 +106,8 @@ "webpackbar": "^5.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.3.0", - "@docusaurus/types": "2.3.0", + "@docusaurus/module-type-aliases": "2.3.1", + "@docusaurus/types": "2.3.1", "@types/detect-port": "^1.3.2", "@types/react-dom": "^18.0.6", "@types/react-router-config": "^5.0.6", diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json index 876da73210..8f4c954541 100644 --- a/packages/eslint-plugin/package.json +++ b/packages/eslint-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/eslint-plugin", - "version": "2.3.0", + "version": "2.3.1", "description": "ESLint plugin to enforce best Docusaurus practices.", "main": "lib/index.js", "keywords": [ diff --git a/packages/lqip-loader/package.json b/packages/lqip-loader/package.json index 301bb8ef99..2379036f4b 100644 --- a/packages/lqip-loader/package.json +++ b/packages/lqip-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/lqip-loader", - "version": "2.3.0", + "version": "2.3.1", "description": "Low Quality Image Placeholders (LQIP) loader for webpack.", "main": "lib/index.js", "publishConfig": { @@ -17,7 +17,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.3.0", + "@docusaurus/logger": "2.3.1", "file-loader": "^6.2.0", "lodash": "^4.17.21", "sharp": "^0.30.7", diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index a136724174..46292b26e3 100644 --- a/packages/stylelint-copyright/package.json +++ b/packages/stylelint-copyright/package.json @@ -1,6 +1,6 @@ { "name": "stylelint-copyright", - "version": "2.3.0", + "version": "2.3.1", "description": "Stylelint plugin to check CSS files for a copyright header.", "main": "lib/index.js", "license": "MIT", diff --git a/website/_dogfooding/_pages tests/tabs-tests.mdx b/website/_dogfooding/_pages tests/tabs-tests.mdx index af7dd77e12..6b72ab24f6 100644 --- a/website/_dogfooding/_pages tests/tabs-tests.mdx +++ b/website/_dogfooding/_pages tests/tabs-tests.mdx @@ -20,3 +20,29 @@ export const isMacOS = typeof window !== 'undefined' && navigator.platform.start ``` + +## Tabs sync with different heights + +```mdx-code-block + + + Use Ctrl + C to copy. + + + very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text very long text + + +``` + +```mdx-code-block + + + Use Ctrl + V to paste. + + + Use Command + V to paste. + + +``` + +When clicking tabs above, they should stay under cursor and we should adjust the scroll position. diff --git a/website/package.json b/website/package.json index cec6154070..2cfb310d9f 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "website", - "version": "2.3.0", + "version": "2.3.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -36,19 +36,19 @@ "dependencies": { "@crowdin/cli": "^3.7.9", "@crowdin/crowdin-api-client": "^1.18.2", - "@docusaurus/core": "2.3.0", - "@docusaurus/logger": "2.3.0", - "@docusaurus/plugin-client-redirects": "2.3.0", - "@docusaurus/plugin-ideal-image": "2.3.0", - "@docusaurus/plugin-pwa": "2.3.0", - "@docusaurus/preset-classic": "2.3.0", - "@docusaurus/remark-plugin-npm2yarn": "2.3.0", - "@docusaurus/theme-classic": "2.3.0", - "@docusaurus/theme-common": "2.3.0", - "@docusaurus/theme-live-codeblock": "2.3.0", - "@docusaurus/theme-mermaid": "2.3.0", - "@docusaurus/utils": "2.3.0", - "@docusaurus/utils-common": "2.3.0", + "@docusaurus/core": "2.3.1", + "@docusaurus/logger": "2.3.1", + "@docusaurus/plugin-client-redirects": "2.3.1", + "@docusaurus/plugin-ideal-image": "2.3.1", + "@docusaurus/plugin-pwa": "2.3.1", + "@docusaurus/preset-classic": "2.3.1", + "@docusaurus/remark-plugin-npm2yarn": "2.3.1", + "@docusaurus/theme-classic": "2.3.1", + "@docusaurus/theme-common": "2.3.1", + "@docusaurus/theme-live-codeblock": "2.3.1", + "@docusaurus/theme-mermaid": "2.3.1", + "@docusaurus/utils": "2.3.1", + "@docusaurus/utils-common": "2.3.1", "@popperjs/core": "^2.11.5", "@swc/core": "1.2.197", "clsx": "^1.2.1", @@ -82,7 +82,7 @@ ] }, "devDependencies": { - "@docusaurus/eslint-plugin": "2.3.0", + "@docusaurus/eslint-plugin": "2.3.1", "@tsconfig/docusaurus": "^1.0.5", "@types/jest": "^28.1.4", "cross-env": "^7.0.3", diff --git a/yarn.lock b/yarn.lock index a9731a2388..37a905f3e7 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7409,10 +7409,10 @@ esutils@^2.0.2: resolved "https://registry.yarnpkg.com/esutils/-/esutils-2.0.3.tgz#74d2eb4de0b8da1293711910d50775b9b710ef64" integrity sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g== -eta@^1.12.3: - version "1.12.3" - resolved "https://registry.yarnpkg.com/eta/-/eta-1.12.3.tgz#2982d08adfbef39f9fa50e2fbd42d7337e7338b1" - integrity sha512-qHixwbDLtekO/d51Yr4glcaUJCIjGVJyTzuqV4GPlgZo1YpgOKG+avQynErZIYrfM6JIJdtiG2Kox8tbb+DoGg== +eta@^2.0.0: + version "2.0.0" + resolved "https://registry.yarnpkg.com/eta/-/eta-2.0.0.tgz#376865fadebc899e5b6dfce82fae64cbbe47e594" + integrity sha512-NqE7S2VmVwgMS8yBxsH4VgNQjNjLq1gfGU0u9I6Cjh468nPRMoDfGdK9n1p/3Dvsw3ebklDkZsFAnKJ9sefjBA== etag@~1.8.1: version "1.8.1"