diff --git a/CHANGELOG.md b/CHANGELOG.md index a7fae793e2..bb3245d49f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,32 @@ # Docusaurus 2 Changelog +## 2.0.0-beta.20 (2022-05-05) + +#### :bug: Bug Fix + +- `docusaurus` + - [#7342](https://github.com/facebook/docusaurus/pull/7342) fix: avoid flash of page scrolling to top on refresh ([@slorber](https://github.com/slorber)) + - [#7329](https://github.com/facebook/docusaurus/pull/7329) fix(core): inject docusaurus version into SSR as local ([@RDIL](https://github.com/RDIL)) +- `docusaurus-theme-classic` + - [#7341](https://github.com/facebook/docusaurus/pull/7341) fix(theme-classic): properly highlight code block line numbers ([@Josh-Cena](https://github.com/Josh-Cena)) + +#### :memo: Documentation + +- [#7334](https://github.com/facebook/docusaurus/pull/7334) feat(website): make canary release page display actual canary version name ([@Josh-Cena](https://github.com/Josh-Cena)) +- [#7343](https://github.com/facebook/docusaurus/pull/7343) docs: add page for create-docusaurus API documentation ([@Josh-Cena](https://github.com/Josh-Cena)) +- [#7340](https://github.com/facebook/docusaurus/pull/7340) docs: add Yandex Metrika plugin to community plugins ([@sgromkov](https://github.com/sgromkov)) +- [#7336](https://github.com/facebook/docusaurus/pull/7336) fix(website): fix multiple accessibility issues around color contrast ([@Josh-Cena](https://github.com/Josh-Cena)) +- [#7327](https://github.com/facebook/docusaurus/pull/7327) docs: add clarity to versioning behavior ([@pepopowitz](https://github.com/pepopowitz)) + +#### Committers: 6 + +- Alexey Pyltsyn ([@lex111](https://github.com/lex111)) +- Joshua Chen ([@Josh-Cena](https://github.com/Josh-Cena)) +- Reece Dunham ([@RDIL](https://github.com/RDIL)) +- Sergey Gromkov ([@sgromkov](https://github.com/sgromkov)) +- Steven Hicks ([@pepopowitz](https://github.com/pepopowitz)) +- Sébastien Lorber ([@slorber](https://github.com/slorber)) + ## 2.0.0-beta.19 (2022-05-04) #### :rocket: New Feature diff --git a/admin/new.docusaurus.io/package.json b/admin/new.docusaurus.io/package.json index f7e1dad1d7..07fa3c05d8 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.0.0-beta.19", + "version": "2.0.0-beta.20", "private": true, "scripts": { "start": "npx --package netlify-cli netlify dev" diff --git a/lerna.json b/lerna.json index e7f4ab1526..16fca78e9d 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "npmClient": "yarn", "useWorkspaces": true, "changelog": { diff --git a/packages/create-docusaurus/package.json b/packages/create-docusaurus/package.json index 832311751d..8c715fc339 100755 --- a/packages/create-docusaurus/package.json +++ b/packages/create-docusaurus/package.json @@ -1,6 +1,6 @@ { "name": "create-docusaurus", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Create Docusaurus apps easily.", "type": "module", "repository": { @@ -22,7 +22,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.0.0-beta.19", + "@docusaurus/logger": "2.0.0-beta.20", "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 7a78193af9..3f98e42c9f 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.0.0-beta.19", + "version": "2.0.0-beta.20", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,8 +15,8 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/preset-classic": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/preset-classic": "2.0.0-beta.20", "@mdx-js/react": "^1.6.22", "clsx": "^1.1.1", "prism-react-renderer": "^1.3.1", @@ -24,7 +24,7 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19", + "@docusaurus/module-type-aliases": "2.0.0-beta.20", "@tsconfig/docusaurus": "^1.0.5", "typescript": "^4.6.4" }, diff --git a/packages/create-docusaurus/templates/classic/package.json b/packages/create-docusaurus/templates/classic/package.json index 1e714b2e4c..bc39e6d4c0 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.0.0-beta.19", + "version": "2.0.0-beta.20", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -14,8 +14,8 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/preset-classic": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/preset-classic": "2.0.0-beta.20", "@mdx-js/react": "^1.6.22", "clsx": "^1.1.1", "prism-react-renderer": "^1.3.1", @@ -23,7 +23,7 @@ "react-dom": "^17.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19" + "@docusaurus/module-type-aliases": "2.0.0-beta.20" }, "browserslist": { "production": [ diff --git a/packages/create-docusaurus/templates/facebook/package.json b/packages/create-docusaurus/templates/facebook/package.json index f71a9f7c06..0b0f5447f3 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.0.0-beta.19", + "version": "2.0.0-beta.20", "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.0.0-beta.19", - "@docusaurus/preset-classic": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/preset-classic": "2.0.0-beta.20", "@mdx-js/react": "^1.6.22", "clsx": "^1.1.1", "react": "^17.0.2", diff --git a/packages/docusaurus-cssnano-preset/package.json b/packages/docusaurus-cssnano-preset/package.json index a05b00f5c9..48b9c56977 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Advanced cssnano preset for maximum optimization.", "main": "index.js", "license": "MIT", diff --git a/packages/docusaurus-logger/package.json b/packages/docusaurus-logger/package.json index aa5acf0bd9..6c91e0d029 100644 --- a/packages/docusaurus-logger/package.json +++ b/packages/docusaurus-logger/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/logger", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "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 ae682cd973..6be990a287 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Docusaurus Loader for MDX", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -20,8 +20,8 @@ "dependencies": { "@babel/parser": "^7.17.10", "@babel/traverse": "^7.17.10", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", "@mdx-js/mdx": "^1.6.22", "escape-html": "^1.0.3", "file-loader": "^6.2.0", @@ -36,7 +36,7 @@ "webpack": "^5.72.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/types": "2.0.0-beta.20", "@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 e009333faf..475dd592c6 100644 --- a/packages/docusaurus-migrate/package.json +++ b/packages/docusaurus-migrate/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/migrate", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "A CLI tool to migrate from older versions of Docusaurus.", "license": "MIT", "engines": { @@ -23,8 +23,8 @@ }, "dependencies": { "@babel/preset-env": "^7.17.10", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", "@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 2f89e4781a..daf13c265c 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Docusaurus module type aliases.", "types": "./src/index.d.ts", "publishConfig": { @@ -12,7 +12,7 @@ "directory": "packages/docusaurus-module-type-aliases" }, "dependencies": { - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/types": "2.0.0-beta.20", "@types/react": "*", "@types/react-router-config": "*", "@types/react-router-dom": "*", diff --git a/packages/docusaurus-plugin-client-redirects/package.json b/packages/docusaurus-plugin-client-redirects/package.json index 2206369fcd..426d13b139 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.0.0-beta.19", + "version": "2.0.0-beta.20", "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.0.0-beta.19", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-common": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-common": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "eta": "^1.12.3", "fs-extra": "^10.1.0", "lodash": "^4.17.21", "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19" + "@docusaurus/types": "2.0.0-beta.20" }, "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 2b64bfccee..629dccc13c 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Blog plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-blog.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/mdx-loader": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-common": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/mdx-loader": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-common": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "cheerio": "^1.0.0-rc.10", "feed": "^4.2.2", "fs-extra": "^10.1.0", @@ -36,7 +36,7 @@ "webpack": "^5.72.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/types": "2.0.0-beta.20", "escape-string-regexp": "^4.0.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json index a0211ea351..b6dbb6a34d 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Docs plugin for Docusaurus.", "main": "lib/index.js", "sideEffects": false, @@ -25,11 +25,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/mdx-loader": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/mdx-loader": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "combine-promises": "^1.1.0", "fs-extra": "^10.1.0", "import-fresh": "^3.3.0", @@ -41,8 +41,8 @@ "webpack": "^5.72.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19", - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/module-type-aliases": "2.0.0-beta.20", + "@docusaurus/types": "2.0.0-beta.20", "@types/js-yaml": "^4.0.5", "@types/picomatch": "^2.3.0", "commander": "^5.1.0", diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json index bf8328aab3..f5882af81a 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Pages plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-pages.d.ts", @@ -18,17 +18,17 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/mdx-loader": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/mdx-loader": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "fs-extra": "^10.1.0", "remark-admonitions": "^1.2.1", "tslib": "^2.4.0", "webpack": "^5.72.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19" + "@docusaurus/types": "2.0.0-beta.20" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json index 3c7ad85f98..9d3f2fd58a 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Debug plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-debug.d.ts", @@ -18,14 +18,14 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", "fs-extra": "^10.1.0", "react-json-view": "^1.21.3", "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19" + "@docusaurus/types": "2.0.0-beta.20" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json index 7b016afb3b..77f5c813de 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Global analytics (analytics.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19" + "@docusaurus/types": "2.0.0-beta.20" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json index 6131b97c26..854f6d2e87 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Global Site Tag (gtag.js) plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,12 +18,12 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19" + "@docusaurus/types": "2.0.0-beta.20" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json index 9139aa57d8..7c35c575b0 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.0.0-beta.19", + "version": "2.0.0-beta.20", "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", @@ -21,11 +21,11 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/lqip-loader": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/lqip-loader": "2.0.0-beta.20", "@docusaurus/responsive-loader": "^1.7.0", - "@docusaurus/theme-translations": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/theme-translations": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "@endiliey/react-ideal-image": "^0.0.11", "react-waypoint": "^10.1.0", "sharp": "^0.30.4", @@ -33,8 +33,8 @@ "webpack": "^5.72.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19", - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/module-type-aliases": "2.0.0-beta.20", + "@docusaurus/types": "2.0.0-beta.20", "fs-extra": "^10.1.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json index 9d09e1c65f..b698f475d6 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Docusaurus Plugin to add PWA support.", "main": "lib/index.js", "types": "src/plugin-pwa.d.ts", @@ -22,11 +22,11 @@ "dependencies": { "@babel/core": "^7.17.10", "@babel/preset-env": "^7.17.10", - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/theme-common": "2.0.0-beta.19", - "@docusaurus/theme-translations": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/theme-common": "2.0.0-beta.20", + "@docusaurus/theme-translations": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "babel-loader": "^8.2.5", "clsx": "^1.1.1", "core-js": "^3.22.3", @@ -39,7 +39,7 @@ "workbox-window": "^6.5.3" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19", + "@docusaurus/module-type-aliases": "2.0.0-beta.20", "fs-extra": "^10.1.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index 70843427d7..173498665e 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Simple sitemap generation plugin for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,16 +18,16 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-common": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-common": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "fs-extra": "^10.1.0", "sitemap": "^7.1.1", "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19" + "@docusaurus/types": "2.0.0-beta.20" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index 7fb5dbfb39..310a920bf4 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Classic preset for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,17 +18,17 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/plugin-content-blog": "2.0.0-beta.19", - "@docusaurus/plugin-content-docs": "2.0.0-beta.19", - "@docusaurus/plugin-content-pages": "2.0.0-beta.19", - "@docusaurus/plugin-debug": "2.0.0-beta.19", - "@docusaurus/plugin-google-analytics": "2.0.0-beta.19", - "@docusaurus/plugin-google-gtag": "2.0.0-beta.19", - "@docusaurus/plugin-sitemap": "2.0.0-beta.19", - "@docusaurus/theme-classic": "2.0.0-beta.19", - "@docusaurus/theme-common": "2.0.0-beta.19", - "@docusaurus/theme-search-algolia": "2.0.0-beta.19" + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/plugin-content-blog": "2.0.0-beta.20", + "@docusaurus/plugin-content-docs": "2.0.0-beta.20", + "@docusaurus/plugin-content-pages": "2.0.0-beta.20", + "@docusaurus/plugin-debug": "2.0.0-beta.20", + "@docusaurus/plugin-google-analytics": "2.0.0-beta.20", + "@docusaurus/plugin-google-gtag": "2.0.0-beta.20", + "@docusaurus/plugin-sitemap": "2.0.0-beta.20", + "@docusaurus/theme-classic": "2.0.0-beta.20", + "@docusaurus/theme-common": "2.0.0-beta.20", + "@docusaurus/theme-search-algolia": "2.0.0-beta.20" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json index ec42e82bde..a47e1de9c9 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.0.0-beta.19", + "version": "2.0.0-beta.20", "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 ab52446e7a..e2b20b2381 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Classic theme for Docusaurus", "main": "lib/index.js", "types": "src/theme-classic.d.ts", @@ -21,15 +21,15 @@ "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\"" }, "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/plugin-content-blog": "2.0.0-beta.19", - "@docusaurus/plugin-content-docs": "2.0.0-beta.19", - "@docusaurus/plugin-content-pages": "2.0.0-beta.19", - "@docusaurus/theme-common": "2.0.0-beta.19", - "@docusaurus/theme-translations": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-common": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/plugin-content-blog": "2.0.0-beta.20", + "@docusaurus/plugin-content-docs": "2.0.0-beta.20", + "@docusaurus/plugin-content-pages": "2.0.0-beta.20", + "@docusaurus/theme-common": "2.0.0-beta.20", + "@docusaurus/theme-translations": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-common": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "@mdx-js/react": "^1.6.22", "clsx": "^1.1.1", "copy-text-to-clipboard": "^3.0.1", @@ -46,8 +46,8 @@ "@babel/cli": "^7.17.10", "@babel/core": "^7.17.10", "@babel/preset-typescript": "^7.16.7", - "@docusaurus/module-type-aliases": "2.0.0-beta.19", - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/module-type-aliases": "2.0.0-beta.20", + "@docusaurus/types": "2.0.0-beta.20", "@types/mdx-js__react": "^1.5.5", "@types/nprogress": "^0.2.0", "@types/prismjs": "^1.26.0", diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json index db0d27a0b6..7a72444294 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Common code for Docusaurus themes.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -26,10 +26,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19", - "@docusaurus/plugin-content-blog": "2.0.0-beta.19", - "@docusaurus/plugin-content-docs": "2.0.0-beta.19", - "@docusaurus/plugin-content-pages": "2.0.0-beta.19", + "@docusaurus/module-type-aliases": "2.0.0-beta.20", + "@docusaurus/plugin-content-blog": "2.0.0-beta.20", + "@docusaurus/plugin-content-docs": "2.0.0-beta.20", + "@docusaurus/plugin-content-pages": "2.0.0-beta.20", "clsx": "^1.1.1", "parse-numeric-range": "^1.3.0", "prism-react-renderer": "^1.3.1", @@ -37,8 +37,8 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/types": "2.0.0-beta.20", "fs-extra": "^10.1.0", "lodash": "^4.17.21" }, diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json index bc9250161a..2e79749422 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Docusaurus live code block component.", "main": "lib/index.js", "types": "src/theme-live-codeblock.d.ts", @@ -24,10 +24,10 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/theme-common": "2.0.0-beta.19", - "@docusaurus/theme-translations": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/theme-common": "2.0.0-beta.20", + "@docusaurus/theme-translations": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "@philpl/buble": "^0.19.7", "clsx": "^1.1.1", "fs-extra": "^10.1.0", @@ -35,7 +35,7 @@ "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/types": "2.0.0-beta.20", "@types/buble": "^0.20.1" }, "peerDependencies": { diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json index 0ab6a93827..f1e3f6db96 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Algolia search component for Docusaurus.", "main": "lib/index.js", "sideEffects": [ @@ -29,13 +29,13 @@ }, "dependencies": { "@docsearch/react": "^3.0.0", - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/plugin-content-docs": "2.0.0-beta.19", - "@docusaurus/theme-common": "2.0.0-beta.19", - "@docusaurus/theme-translations": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/plugin-content-docs": "2.0.0-beta.20", + "@docusaurus/theme-common": "2.0.0-beta.20", + "@docusaurus/theme-translations": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "algoliasearch": "^4.13.0", "algoliasearch-helper": "^3.8.2", "clsx": "^1.1.1", @@ -46,7 +46,7 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19" + "@docusaurus/module-type-aliases": "2.0.0-beta.20" }, "peerDependencies": { "react": "^16.8.4 || ^17.0.0", diff --git a/packages/docusaurus-theme-translations/package.json b/packages/docusaurus-theme-translations/package.json index 7567032a85..5c27fb37c9 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.0.0-beta.19", + "version": "2.0.0-beta.20", "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.0.0-beta.19", - "@docusaurus/logger": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", "lodash": "^4.17.21" }, "engines": { diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json index e760631b3d..c032ac1990 100644 --- a/packages/docusaurus-types/package.json +++ b/packages/docusaurus-types/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/types", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "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 9a01b9e9f5..31f9a3fcd0 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.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Common (Node/Browser) utility functions for Docusaurus packages.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -22,7 +22,7 @@ "tslib": "^2.4.0" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19" + "@docusaurus/types": "2.0.0-beta.20" }, "engines": { "node": ">=14" diff --git a/packages/docusaurus-utils-validation/package.json b/packages/docusaurus-utils-validation/package.json index c5c9be8983..a112ef5797 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.0.0-beta.19", + "version": "2.0.0-beta.20", "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.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", "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 f774b08d74..bac83d169f 100644 --- a/packages/docusaurus-utils/package.json +++ b/packages/docusaurus-utils/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "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.0.0-beta.19", + "@docusaurus/logger": "2.0.0-beta.20", "@svgr/webpack": "^6.2.1", "file-loader": "^6.2.0", "fs-extra": "^10.1.0", @@ -38,7 +38,7 @@ "node": ">=14" }, "devDependencies": { - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/types": "2.0.0-beta.20", "@types/dedent": "^0.7.0", "@types/github-slugger": "^1.3.0", "@types/micromatch": "^4.0.2", diff --git a/packages/docusaurus/package.json b/packages/docusaurus/package.json index bf3ea72666..3818f4538e 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.0.0-beta.19", + "version": "2.0.0-beta.20", "license": "MIT", "publishConfig": { "access": "public" @@ -41,13 +41,13 @@ "@babel/runtime": "^7.17.9", "@babel/runtime-corejs3": "^7.17.9", "@babel/traverse": "^7.17.10", - "@docusaurus/cssnano-preset": "2.0.0-beta.19", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/mdx-loader": "2.0.0-beta.19", + "@docusaurus/cssnano-preset": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/mdx-loader": "2.0.0-beta.20", "@docusaurus/react-loadable": "5.5.2", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-common": "2.0.0-beta.19", - "@docusaurus/utils-validation": "2.0.0-beta.19", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-common": "2.0.0-beta.20", + "@docusaurus/utils-validation": "2.0.0-beta.20", "@slorber/static-site-generator-webpack-plugin": "^4.0.4", "@svgr/webpack": "^6.2.1", "autoprefixer": "^10.4.5", @@ -104,8 +104,8 @@ "webpackbar": "^5.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "2.0.0-beta.19", - "@docusaurus/types": "2.0.0-beta.19", + "@docusaurus/module-type-aliases": "2.0.0-beta.20", + "@docusaurus/types": "2.0.0-beta.20", "@types/detect-port": "^1.3.2", "@types/react-dom": "^18.0.3", "@types/react-router-config": "^5.0.6", diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json index 6e98792d40..4ce1c224c0 100644 --- a/packages/eslint-plugin/package.json +++ b/packages/eslint-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/eslint-plugin", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "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 c9f166114c..b06ff77805 100644 --- a/packages/lqip-loader/package.json +++ b/packages/lqip-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/lqip-loader", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Low Quality Image Placeholders (LQIP) loader for webpack.", "main": "lib/index.js", "publishConfig": { @@ -17,7 +17,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "2.0.0-beta.19", + "@docusaurus/logger": "2.0.0-beta.20", "file-loader": "^6.2.0", "lodash": "^4.17.21", "sharp": "^0.30.4", diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index c48ef9b150..7f54b84650 100644 --- a/packages/stylelint-copyright/package.json +++ b/packages/stylelint-copyright/package.json @@ -1,6 +1,6 @@ { "name": "stylelint-copyright", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "description": "Stylelint plugin to check CSS files for a copyright header.", "main": "index.js", "license": "MIT", diff --git a/website/community/Versions.tsx b/website/community/Versions.tsx index 15464635e8..83e0bd832d 100644 --- a/website/community/Versions.tsx +++ b/website/community/Versions.tsx @@ -39,9 +39,11 @@ export function VersionsProvider({ function useStableVersion(): string { const preferredVersion = useDocsPreferredVersion('default').preferredVersion?.name; - const lastVersion = useVersions('default').find( - (v) => v.name !== 'current', - )!.name; + + const allVersions = useVersions('default'); + const lastVersion = ( + allVersions.find((v) => v.name !== 'current') ?? allVersions[0] + ).name; return preferredVersion && preferredVersion !== 'current' ? preferredVersion : lastVersion; diff --git a/website/package.json b/website/package.json index 3545210fb2..6123b94ef2 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "website", - "version": "2.0.0-beta.19", + "version": "2.0.0-beta.20", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -36,18 +36,18 @@ "dependencies": { "@crowdin/cli": "^3.7.8", "@crowdin/crowdin-api-client": "^1.18.0", - "@docusaurus/core": "2.0.0-beta.19", - "@docusaurus/logger": "2.0.0-beta.19", - "@docusaurus/plugin-client-redirects": "2.0.0-beta.19", - "@docusaurus/plugin-ideal-image": "2.0.0-beta.19", - "@docusaurus/plugin-pwa": "2.0.0-beta.19", - "@docusaurus/preset-classic": "2.0.0-beta.19", - "@docusaurus/remark-plugin-npm2yarn": "2.0.0-beta.19", - "@docusaurus/theme-classic": "2.0.0-beta.19", - "@docusaurus/theme-common": "2.0.0-beta.19", - "@docusaurus/theme-live-codeblock": "2.0.0-beta.19", - "@docusaurus/utils": "2.0.0-beta.19", - "@docusaurus/utils-common": "2.0.0-beta.19", + "@docusaurus/core": "2.0.0-beta.20", + "@docusaurus/logger": "2.0.0-beta.20", + "@docusaurus/plugin-client-redirects": "2.0.0-beta.20", + "@docusaurus/plugin-ideal-image": "2.0.0-beta.20", + "@docusaurus/plugin-pwa": "2.0.0-beta.20", + "@docusaurus/preset-classic": "2.0.0-beta.20", + "@docusaurus/remark-plugin-npm2yarn": "2.0.0-beta.20", + "@docusaurus/theme-classic": "2.0.0-beta.20", + "@docusaurus/theme-common": "2.0.0-beta.20", + "@docusaurus/theme-live-codeblock": "2.0.0-beta.20", + "@docusaurus/utils": "2.0.0-beta.20", + "@docusaurus/utils-common": "2.0.0-beta.20", "@popperjs/core": "^2.11.5", "@swc/core": "^1.2.174", "clsx": "^1.1.1", @@ -79,7 +79,7 @@ ] }, "devDependencies": { - "@docusaurus/eslint-plugin": "2.0.0-beta.19", + "@docusaurus/eslint-plugin": "2.0.0-beta.20", "@tsconfig/docusaurus": "^1.0.5", "@types/jest": "^27.4.1", "cross-env": "^7.0.3", diff --git a/website/versioned_docs/version-2.0.0-beta.18/guides/docs/docs-markdown-features.mdx b/website/versioned_docs/version-2.0.0-beta.18/guides/docs/docs-markdown-features.mdx deleted file mode 100644 index 40be16cb9e..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.18/guides/docs/docs-markdown-features.mdx +++ /dev/null @@ -1,39 +0,0 @@ ---- -id: markdown-features -title: Docs Markdown Features -description: Docusaurus Markdown features that are specific to the docs plugin -slug: /docs-markdown-features ---- - -Docs can use any [Markdown feature](../markdown-features/markdown-features-intro.mdx) and have a few additional docs-specific Markdown features. - -## Markdown front matter {#markdown-front-matter} - -Markdown docs have their own [Markdown front matter API](../../api/plugins/plugin-content-docs.md#markdown-front-matter). - -## Referencing other documents {#referencing-other-documents} - -If you want to reference another document file, you could use the relative path of the document you want to link to. - -Docusaurus will convert the file path to be the final document url path (and remove the `.md` extension). - -For example, if you are in `folder/doc1.md` and you want to reference `folder/doc2.md`, `folder/subfolder/doc3.md` and `otherFolder/doc4.md`: - -```md -I am referencing a [document](doc2.md). - -Reference to another [document in a subfolder](subfolder/doc3.md). - -[Relative document](../otherFolder/doc4.md) referencing works as well. -``` - -:::tip - -Using relative _file_ paths (with `.md` extensions) instead of relative _URL_ links provides the following benefits: - -- links will keep working on the GitHub interface -- you can customize the document slugs without having to update all the links -- a versioned doc will link to another doc of the exact same version -- relative links are very likely to break if you update the [`trailingSlash` config](../../api/docusaurus.config.js.md#trailing-slash) - -::: diff --git a/website/versioned_docs/version-2.0.0-beta.18/guides/markdown-features/markdown-features-headings.mdx b/website/versioned_docs/version-2.0.0-beta.18/guides/markdown-features/markdown-features-headings.mdx deleted file mode 100644 index a4beb7bba3..0000000000 --- a/website/versioned_docs/version-2.0.0-beta.18/guides/markdown-features/markdown-features-headings.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: headings -title: Headings -description: Using Markdown headings -slug: /markdown-features/headings ---- - -## Markdown headings {#markdown-headings} - -You can use regular Markdown headings. - -``` -## Level 2 title - -### Level 3 title - -#### Level 4 title -``` - -Markdown headings appear as a table of contents entry. - -## Heading ids {#heading-ids} - -Each heading has an id that can be automatically generated or explicitly specified. - -Heading ids allow you to link to a specific document heading in Markdown or JSX: - -```md -[link](#heading-id) -``` - -```jsx -link -``` - -### Generated ids {#generated-ids} - -By default, Docusaurus will generate heading ids for you, based on the heading text. For example, `### Hello World` will have id `hello-world`. - -Generated ids have **some limits**: - -- The id might not look good -- You might want to **change or translate** the text without updating the existing id - -### Explicit ids {#explicit-ids} - -A special Markdown syntax lets you set an **explicit heading id**: - -```md -### Hello World {#my-explicit-id} -``` - -:::tip - -Use the **[write-heading-ids](../../cli.md#docusaurus-write-heading-ids-sitedir)** CLI command to add explicit ids to all your Markdown documents. - -::: diff --git a/website/versioned_docs/version-2.0.0-beta.18/advanced/architecture.md b/website/versioned_docs/version-2.0.0-beta.20/advanced/architecture.md similarity index 100% rename from website/versioned_docs/version-2.0.0-beta.18/advanced/architecture.md rename to website/versioned_docs/version-2.0.0-beta.20/advanced/architecture.md diff --git a/website/versioned_docs/version-2.0.0-beta.18/advanced/client.md b/website/versioned_docs/version-2.0.0-beta.20/advanced/client.md similarity index 65% rename from website/versioned_docs/version-2.0.0-beta.18/advanced/client.md rename to website/versioned_docs/version-2.0.0-beta.20/advanced/client.md index ef4c4d220c..6019e73289 100644 --- a/website/versioned_docs/version-2.0.0-beta.18/advanced/client.md +++ b/website/versioned_docs/version-2.0.0-beta.20/advanced/client.md @@ -86,7 +86,7 @@ Client modules are part of your site's bundle, just like theme components. Howev These modules are imported globally before React even renders the initial UI. -```js title="App.tsx" +```js title="@docusaurus/core/App.tsx" // How it works under the hood import '@generated/client-modules'; ``` @@ -117,5 +117,70 @@ CSS stylesheets imported as client modules are [global](../styling-layout.md#glo } ``` - - +### Client module lifecycles {#client-module-lifecycles} + +Besides introducing side-effects, client modules can optionally export two lifecycle functions: `onRouteUpdate` and `onRouteDidUpdate`. + +Because Docusaurus builds a single-page application, `script` tags will only be executed the first time the page loads, but will not re-execute on page transitions. These lifecycles are useful if you have some imperative JS logic that should execute every time a new page has loaded, e.g., to manipulate DOM elements, to send analytics data, etc. + +For every route transition, there will be several important timings: + +1. The user clicks a link, which causes the router to change its current location. +2. Docusaurus preloads the next route's assets, while keeping displaying the current page's content. +3. The next route's assets have loaded. +4. The new location's route component gets rendered to DOM. + +`onRouteUpdate` will be called at event (2), and `onRouteDidUpdate` will be called at (4). They both receive the current location and the previous location (which can be `null`, if this is the first screen). + +`onRouteUpdate` can optionally return a "cleanup" callback, which will be called at (3). For example, if you want to display a progress bar, you can start a timeout in `onRouteUpdate`, and clear the timeout in the callback. (The classic theme already provides an `nprogress` integration this way.) + +Note that the new page's DOM is only available during event (4). If you need to manipulate the new page's DOM, you'll likely want to use `onRouteDidUpdate`, which will be fired as soon as the DOM on the new page has mounted. + +```js title="myClientModule.js" +import type {Location} from 'history'; + +export function onRouteDidUpdate({location, previousLocation}) { + // Don't execute if we are still on the same page; the lifecycle may be fired + // because the hash changes (e.g. when navigating between headings) + if (location.pathname !== previousLocation?.pathname) { + const title = document.getElementsByTagName('h1')[0]; + if (title) { + title.innerText += '❤️'; + } + } +} + +export function onRouteUpdate({location, previousLocation}) { + if (location.pathname !== previousLocation?.pathname) { + const progressBarTimeout = window.setTimeout(() => { + nprogress.start(); + }, delay); + return () => window.clearTimeout(progressBarTimeout); + } + return undefined; +} +``` + +Or, if you are using TypeScript and you want to leverage contextual typing: + +```ts title="myClientModule.ts" +import type {ClientModule} from '@docusaurus/types'; + +const module: ClientModule = { + onRouteUpdate({location, previousLocation}) { + // ... + }, + onRouteDidUpdate({location, previousLocation}) { + // ... + }, +}; +export default module; +``` + +Both lifecycles will fire on first render, but they will not fire on server-side, so you can safely access browser globals in them. + +:::tip Prefer using React + +Client module lifecycles are purely imperative, and you can't use React hooks or access React contexts within them. If your operations are state-driven or involve complicated DOM manipulations, you should consider [swizzling components](../swizzling.md) instead. + +::: diff --git a/website/versioned_docs/version-2.0.0-beta.18/advanced/index.md b/website/versioned_docs/version-2.0.0-beta.20/advanced/index.md similarity index 100% rename from website/versioned_docs/version-2.0.0-beta.18/advanced/index.md rename to website/versioned_docs/version-2.0.0-beta.20/advanced/index.md diff --git a/website/versioned_docs/version-2.0.0-beta.18/advanced/plugins.md b/website/versioned_docs/version-2.0.0-beta.20/advanced/plugins.md similarity index 99% rename from website/versioned_docs/version-2.0.0-beta.18/advanced/plugins.md rename to website/versioned_docs/version-2.0.0-beta.20/advanced/plugins.md index 5e45b9d82b..29910ff0e2 100644 --- a/website/versioned_docs/version-2.0.0-beta.18/advanced/plugins.md +++ b/website/versioned_docs/version-2.0.0-beta.20/advanced/plugins.md @@ -51,7 +51,7 @@ module.exports = { Then in the folder `my-plugin`, you can create an `index.js` such as this: -```js title="my-plugin.js" +```js title="my-plugin/index.js" module.exports = async function myPlugin(context, options) { // ... return { diff --git a/website/versioned_docs/version-2.0.0-beta.18/advanced/routing.md b/website/versioned_docs/version-2.0.0-beta.20/advanced/routing.md similarity index 98% rename from website/versioned_docs/version-2.0.0-beta.18/advanced/routing.md rename to website/versioned_docs/version-2.0.0-beta.20/advanced/routing.md index 9aca36f249..82c85b7aae 100644 --- a/website/versioned_docs/version-2.0.0-beta.18/advanced/routing.md +++ b/website/versioned_docs/version-2.0.0-beta.20/advanced/routing.md @@ -257,14 +257,14 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- /pure-html +- [/pure-html](/pure-html) - [pathname:///pure-html](pathname:///pure-html) :::tip -The first link will trigger a "broken links detected" check during the production build. +The first link will **not** trigger a "broken links detected" check during the production build, because the respective file actually exists. Nevertheless, when you click on the link, a "page not found" will be displayed until you refresh. ::: diff --git a/website/versioned_docs/version-2.0.0-beta.18/advanced/ssg.md b/website/versioned_docs/version-2.0.0-beta.20/advanced/ssg.md similarity index 93% rename from website/versioned_docs/version-2.0.0-beta.18/advanced/ssg.md rename to website/versioned_docs/version-2.0.0-beta.20/advanced/ssg.md index b5b4e81f9f..0a394f9179 100644 --- a/website/versioned_docs/version-2.0.0-beta.18/advanced/ssg.md +++ b/website/versioned_docs/version-2.0.0-beta.20/advanced/ssg.md @@ -100,6 +100,8 @@ These HTML files are the first to arrive at the user's browser screen when a URL In CSR-only apps, all DOM elements are generated on client side with React, and the HTML file only ever contains one root element for React to mount DOM to; in SSR, React is already facing a fully built HTML page, and it only needs to correlate the DOM elements with the virtual DOM in its model. This step is called "hydration". After React has hydrated the static markup, the app starts to work as any normal React app. +Note that Docusaurus is ultimately a single-page application, so static site generation is only an optimization (_progressive enhancement_, as it's called), but our functionality does not fully depend on those HTML files. This is contrary to site generators like [Jekyll](https://jekyllrb.com/) and [Docusaurus v1](https://v1.docusaurus.io/), where all files are statically transformed to markup, and interactiveness is added through external JavaScript linked with `