diff --git a/admin/new.docusaurus.io/package.json b/admin/new.docusaurus.io/package.json index c021a529a0b5..72ad4dd1e9bb 100644 --- a/admin/new.docusaurus.io/package.json +++ b/admin/new.docusaurus.io/package.json @@ -1,6 +1,6 @@ { "name": "new.docusaurus.io", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "private": true, "scripts": { "start": "npx --package netlify-cli netlify dev" diff --git a/argos/package.json b/argos/package.json index c768135cfd61..f3e923b7075b 100644 --- a/argos/package.json +++ b/argos/package.json @@ -1,6 +1,6 @@ { "name": "argos", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Argos visual diff tests", "license": "MIT", "private": true, diff --git a/lerna.json b/lerna.json index 4cca80399c1d..78f954df89b3 100644 --- a/lerna.json +++ b/lerna.json @@ -1,5 +1,5 @@ { - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "npmClient": "yarn", "useWorkspaces": true, "useNx": false, diff --git a/packages/create-docusaurus/package.json b/packages/create-docusaurus/package.json index e3acb5e6ba83..bca85b3428e5 100755 --- a/packages/create-docusaurus/package.json +++ b/packages/create-docusaurus/package.json @@ -1,6 +1,6 @@ { "name": "create-docusaurus", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Create Docusaurus apps easily.", "type": "module", "repository": { @@ -22,8 +22,8 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", "commander": "^5.1.0", "fs-extra": "^11.1.1", "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 73cd0f7a2b67..9561e2768d5d 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": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -15,8 +15,8 @@ "typecheck": "tsc" }, "dependencies": { - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/preset-classic": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/preset-classic": "3.0.0-rc.1", "@mdx-js/react": "^3.0.0", "clsx": "^1.2.1", "prism-react-renderer": "^2.1.0", @@ -24,9 +24,9 @@ "react-dom": "^18.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.0.0-rc.0", - "@docusaurus/tsconfig": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", + "@docusaurus/tsconfig": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", "typescript": "~5.2.2" }, "browserslist": { diff --git a/packages/create-docusaurus/templates/classic/package.json b/packages/create-docusaurus/templates/classic/package.json index d2d1859b4aa4..44ad8812b63a 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": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -14,8 +14,8 @@ "write-heading-ids": "docusaurus write-heading-ids" }, "dependencies": { - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/preset-classic": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/preset-classic": "3.0.0-rc.1", "@mdx-js/react": "^3.0.0", "clsx": "^1.2.1", "prism-react-renderer": "^2.1.0", @@ -23,8 +23,8 @@ "react-dom": "^18.0.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0" + "@docusaurus/module-type-aliases": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1" }, "browserslist": { "production": [ diff --git a/packages/docusaurus-cssnano-preset/package.json b/packages/docusaurus-cssnano-preset/package.json index 4ed2f523793a..b1a38124ec43 100644 --- a/packages/docusaurus-cssnano-preset/package.json +++ b/packages/docusaurus-cssnano-preset/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/cssnano-preset", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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 54d4b2474888..5bbb792d16f3 100644 --- a/packages/docusaurus-logger/package.json +++ b/packages/docusaurus-logger/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/logger", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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 ee592ead46ce..0addfff0b525 100644 --- a/packages/docusaurus-mdx-loader/package.json +++ b/packages/docusaurus-mdx-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/mdx-loader", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Docusaurus Loader for MDX", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -20,9 +20,9 @@ "dependencies": { "@babel/parser": "^7.22.7", "@babel/traverse": "^7.22.8", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "@mdx-js/mdx": "^3.0.0", "@slorber/remark-comment": "^1.0.0", "escape-html": "^1.0.3", @@ -46,7 +46,7 @@ "webpack": "^5.88.1" }, "devDependencies": { - "@docusaurus/types": "3.0.0-rc.0", + "@docusaurus/types": "3.0.0-rc.1", "@types/escape-html": "^1.0.2", "@types/mdast": "^4.0.2", "@types/stringify-object": "^3.3.1", diff --git a/packages/docusaurus-module-type-aliases/package.json b/packages/docusaurus-module-type-aliases/package.json index d7453625ee11..65bcf09ad8af 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", + "@docusaurus/types": "3.0.0-rc.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 368813e2b67e..55bfdb677cab 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-common": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-common": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "eta": "^2.2.0", "fs-extra": "^11.1.1", "lodash": "^4.17.21", "tslib": "^2.6.0" }, "devDependencies": { - "@docusaurus/types": "3.0.0-rc.0" + "@docusaurus/types": "3.0.0-rc.1" }, "peerDependencies": { "react": "^18.0.0", diff --git a/packages/docusaurus-plugin-content-blog/package.json b/packages/docusaurus-plugin-content-blog/package.json index 59a8a08692d5..f1c0f29e7cea 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": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Blog plugin for Docusaurus.", "main": "lib/index.js", "types": "src/plugin-content-blog.d.ts", @@ -19,13 +19,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/mdx-loader": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-common": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/mdx-loader": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-common": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "cheerio": "^1.0.0-rc.12", "feed": "^4.2.2", "fs-extra": "^11.1.1", diff --git a/packages/docusaurus-plugin-content-docs/package.json b/packages/docusaurus-plugin-content-docs/package.json index 5f744a8f05b7..4a18682ffe35 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": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Docs plugin for Docusaurus.", "main": "lib/index.js", "sideEffects": false, @@ -35,13 +35,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/mdx-loader": "3.0.0-rc.0", - "@docusaurus/module-type-aliases": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/mdx-loader": "3.0.0-rc.1", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "@types/react-router-config": "^5.0.7", "combine-promises": "^1.1.0", "fs-extra": "^11.1.1", diff --git a/packages/docusaurus-plugin-content-pages/package.json b/packages/docusaurus-plugin-content-pages/package.json index c321a31e0f66..3375fc603d84 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/mdx-loader": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/mdx-loader": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "fs-extra": "^11.1.1", "tslib": "^2.6.0", "webpack": "^5.88.1" diff --git a/packages/docusaurus-plugin-debug/package.json b/packages/docusaurus-plugin-debug/package.json index 4d12b67e16c9..043e84ce4e2c 100644 --- a/packages/docusaurus-plugin-debug/package.json +++ b/packages/docusaurus-plugin-debug/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-debug", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", "@microlink/react-json-view": "^1.22.2", "fs-extra": "^11.1.1", "tslib": "^2.6.0" diff --git a/packages/docusaurus-plugin-google-analytics/package.json b/packages/docusaurus-plugin-google-analytics/package.json index 3298dd94da36..cfc2dbe7c4cc 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "tslib": "^2.6.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-google-gtag/package.json b/packages/docusaurus-plugin-google-gtag/package.json index 0ff1c44e97ab..cdd9a789668c 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "@types/gtag.js": "^0.0.12", "tslib": "^2.6.0" }, diff --git a/packages/docusaurus-plugin-google-tag-manager/package.json b/packages/docusaurus-plugin-google-tag-manager/package.json index 96721038e90d..b6e4af132a20 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "tslib": "^2.6.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-ideal-image/package.json b/packages/docusaurus-plugin-ideal-image/package.json index 82331bbd85f3..c0d82f4eeb59 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/lqip-loader": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/lqip-loader": "3.0.0-rc.1", "@docusaurus/responsive-loader": "^1.7.0", - "@docusaurus/theme-translations": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/theme-translations": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "@slorber/react-ideal-image": "^0.0.12", "react-waypoint": "^10.3.0", "sharp": "^0.32.3", @@ -33,7 +33,7 @@ "webpack": "^5.88.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.0.0-rc.0", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", "fs-extra": "^11.1.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-pwa/package.json b/packages/docusaurus-plugin-pwa/package.json index bb8a47817097..a20af1136e6f 100644 --- a/packages/docusaurus-plugin-pwa/package.json +++ b/packages/docusaurus-plugin-pwa/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-pwa", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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.22.9", "@babel/preset-env": "^7.22.9", - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/theme-common": "3.0.0-rc.0", - "@docusaurus/theme-translations": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/theme-common": "3.0.0-rc.1", + "@docusaurus/theme-translations": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "babel-loader": "^9.1.3", "clsx": "^1.2.1", "core-js": "^3.31.1", @@ -41,7 +41,7 @@ "workbox-window": "^6.6.1" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.0.0-rc.0", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", "fs-extra": "^11.1.0" }, "peerDependencies": { diff --git a/packages/docusaurus-plugin-sitemap/package.json b/packages/docusaurus-plugin-sitemap/package.json index 6522d0582d0e..e91ba04b4105 100644 --- a/packages/docusaurus-plugin-sitemap/package.json +++ b/packages/docusaurus-plugin-sitemap/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/plugin-sitemap", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-common": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-common": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "fs-extra": "^11.1.1", "sitemap": "^7.1.1", "tslib": "^2.6.0" diff --git a/packages/docusaurus-preset-classic/package.json b/packages/docusaurus-preset-classic/package.json index 4135c827bf82..7efda144eb88 100644 --- a/packages/docusaurus-preset-classic/package.json +++ b/packages/docusaurus-preset-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/preset-classic", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Classic preset for Docusaurus.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -18,19 +18,19 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/plugin-content-blog": "3.0.0-rc.0", - "@docusaurus/plugin-content-docs": "3.0.0-rc.0", - "@docusaurus/plugin-content-pages": "3.0.0-rc.0", - "@docusaurus/plugin-debug": "3.0.0-rc.0", - "@docusaurus/plugin-google-analytics": "3.0.0-rc.0", - "@docusaurus/plugin-google-gtag": "3.0.0-rc.0", - "@docusaurus/plugin-google-tag-manager": "3.0.0-rc.0", - "@docusaurus/plugin-sitemap": "3.0.0-rc.0", - "@docusaurus/theme-classic": "3.0.0-rc.0", - "@docusaurus/theme-common": "3.0.0-rc.0", - "@docusaurus/theme-search-algolia": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0" + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/plugin-content-blog": "3.0.0-rc.1", + "@docusaurus/plugin-content-docs": "3.0.0-rc.1", + "@docusaurus/plugin-content-pages": "3.0.0-rc.1", + "@docusaurus/plugin-debug": "3.0.0-rc.1", + "@docusaurus/plugin-google-analytics": "3.0.0-rc.1", + "@docusaurus/plugin-google-gtag": "3.0.0-rc.1", + "@docusaurus/plugin-google-tag-manager": "3.0.0-rc.1", + "@docusaurus/plugin-sitemap": "3.0.0-rc.1", + "@docusaurus/theme-classic": "3.0.0-rc.1", + "@docusaurus/theme-common": "3.0.0-rc.1", + "@docusaurus/theme-search-algolia": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1" }, "peerDependencies": { "react": "^18.0.0", diff --git a/packages/docusaurus-remark-plugin-npm2yarn/package.json b/packages/docusaurus-remark-plugin-npm2yarn/package.json index 37113ca2b9a3..e788a045723f 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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 6b87b499dc54..a7808aa03e50 100644 --- a/packages/docusaurus-theme-classic/package.json +++ b/packages/docusaurus-theme-classic/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-classic", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/mdx-loader": "3.0.0-rc.0", - "@docusaurus/module-type-aliases": "3.0.0-rc.0", - "@docusaurus/plugin-content-blog": "3.0.0-rc.0", - "@docusaurus/plugin-content-docs": "3.0.0-rc.0", - "@docusaurus/plugin-content-pages": "3.0.0-rc.0", - "@docusaurus/theme-common": "3.0.0-rc.0", - "@docusaurus/theme-translations": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-common": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/mdx-loader": "3.0.0-rc.1", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", + "@docusaurus/plugin-content-blog": "3.0.0-rc.1", + "@docusaurus/plugin-content-docs": "3.0.0-rc.1", + "@docusaurus/plugin-content-pages": "3.0.0-rc.1", + "@docusaurus/theme-common": "3.0.0-rc.1", + "@docusaurus/theme-translations": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-common": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "@mdx-js/react": "^3.0.0", "clsx": "^1.2.1", "copy-text-to-clipboard": "^3.2.0", diff --git a/packages/docusaurus-theme-common/package.json b/packages/docusaurus-theme-common/package.json index b0b215a62067..cfc0c33e0d22 100644 --- a/packages/docusaurus-theme-common/package.json +++ b/packages/docusaurus-theme-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-common", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Common code for Docusaurus themes.", "main": "./lib/index.js", "types": "./lib/index.d.ts", @@ -30,13 +30,13 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/mdx-loader": "3.0.0-rc.0", - "@docusaurus/module-type-aliases": "3.0.0-rc.0", - "@docusaurus/plugin-content-blog": "3.0.0-rc.0", - "@docusaurus/plugin-content-docs": "3.0.0-rc.0", - "@docusaurus/plugin-content-pages": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-common": "3.0.0-rc.0", + "@docusaurus/mdx-loader": "3.0.0-rc.1", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", + "@docusaurus/plugin-content-blog": "3.0.0-rc.1", + "@docusaurus/plugin-content-docs": "3.0.0-rc.1", + "@docusaurus/plugin-content-pages": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-common": "3.0.0-rc.1", "@types/history": "^4.7.11", "@types/react": "*", "@types/react-router-config": "*", @@ -47,8 +47,8 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", "fs-extra": "^11.1.1", "lodash": "^4.17.21" }, diff --git a/packages/docusaurus-theme-live-codeblock/package.json b/packages/docusaurus-theme-live-codeblock/package.json index 3ba59fa19e48..0daf33dfdce9 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": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/theme-common": "3.0.0-rc.0", - "@docusaurus/theme-translations": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/theme-common": "3.0.0-rc.1", + "@docusaurus/theme-translations": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "@philpl/buble": "^0.19.7", "clsx": "^1.2.1", "fs-extra": "^11.1.1", @@ -34,7 +34,7 @@ "tslib": "^2.6.0" }, "devDependencies": { - "@docusaurus/types": "3.0.0-rc.0", + "@docusaurus/types": "3.0.0-rc.1", "@types/buble": "^0.20.1" }, "peerDependencies": { diff --git a/packages/docusaurus-theme-mermaid/package.json b/packages/docusaurus-theme-mermaid/package.json index 4d78e043c7ff..4fd565b374df 100644 --- a/packages/docusaurus-theme-mermaid/package.json +++ b/packages/docusaurus-theme-mermaid/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-mermaid", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/module-type-aliases": "3.0.0-rc.0", - "@docusaurus/theme-common": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", + "@docusaurus/theme-common": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "mermaid": "^10.4.0", "tslib": "^2.6.0" }, diff --git a/packages/docusaurus-theme-search-algolia/package.json b/packages/docusaurus-theme-search-algolia/package.json index f5a2d6a7564c..5cde70bf225d 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": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Algolia search component for Docusaurus.", "main": "lib/index.js", "sideEffects": [ @@ -34,13 +34,13 @@ }, "dependencies": { "@docsearch/react": "^3.5.2", - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/plugin-content-docs": "3.0.0-rc.0", - "@docusaurus/theme-common": "3.0.0-rc.0", - "@docusaurus/theme-translations": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/plugin-content-docs": "3.0.0-rc.1", + "@docusaurus/theme-common": "3.0.0-rc.1", + "@docusaurus/theme-translations": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "algoliasearch": "^4.18.0", "algoliasearch-helper": "^3.13.3", "clsx": "^1.2.1", @@ -51,7 +51,7 @@ "utility-types": "^3.10.0" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.0.0-rc.0" + "@docusaurus/module-type-aliases": "3.0.0-rc.1" }, "peerDependencies": { "react": "^18.0.0", diff --git a/packages/docusaurus-theme-translations/package.json b/packages/docusaurus-theme-translations/package.json index b627cf41bb3a..93cfa98e2392 100644 --- a/packages/docusaurus-theme-translations/package.json +++ b/packages/docusaurus-theme-translations/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/theme-translations", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Docusaurus theme translations.", "main": "lib/index.js", "types": "lib/index.d.ts", @@ -23,8 +23,8 @@ "tslib": "^2.6.0" }, "devDependencies": { - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", "lodash": "^4.17.21" }, "engines": { diff --git a/packages/docusaurus-tsconfig/package.json b/packages/docusaurus-tsconfig/package.json index 0f41e4e4167f..d3fdb6008cf1 100644 --- a/packages/docusaurus-tsconfig/package.json +++ b/packages/docusaurus-tsconfig/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/tsconfig", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Docusaurus base TypeScript configuration.", "main": "tsconfig.json", "publishConfig": { diff --git a/packages/docusaurus-types/package.json b/packages/docusaurus-types/package.json index 680d8fc40a1a..0f4e5dc5f00c 100644 --- a/packages/docusaurus-types/package.json +++ b/packages/docusaurus-types/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/types", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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 85370f78dc6d..ef298db64be3 100644 --- a/packages/docusaurus-utils-common/package.json +++ b/packages/docusaurus-utils-common/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-common", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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 0a5ebcfb85ea..f9cc1aae8717 100644 --- a/packages/docusaurus-utils-validation/package.json +++ b/packages/docusaurus-utils-validation/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils-validation", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", "joi": "^17.9.2", "js-yaml": "^4.1.0", "tslib": "^2.6.0" diff --git a/packages/docusaurus-utils/package.json b/packages/docusaurus-utils/package.json index b25bd96bbe02..5942160a4627 100644 --- a/packages/docusaurus-utils/package.json +++ b/packages/docusaurus-utils/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/utils", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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": "3.0.0-rc.0", + "@docusaurus/logger": "3.0.0-rc.1", "@svgr/webpack": "^6.5.1", "escape-string-regexp": "^4.0.0", "file-loader": "^6.2.0", @@ -40,7 +40,7 @@ "node": ">=18.0" }, "devDependencies": { - "@docusaurus/types": "3.0.0-rc.0", + "@docusaurus/types": "3.0.0-rc.1", "@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 5d0542c4f21d..3875841b41c7 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": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "license": "MIT", "publishConfig": { "access": "public" @@ -43,13 +43,13 @@ "@babel/runtime": "^7.22.6", "@babel/runtime-corejs3": "^7.22.6", "@babel/traverse": "^7.22.8", - "@docusaurus/cssnano-preset": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/mdx-loader": "3.0.0-rc.0", + "@docusaurus/cssnano-preset": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/mdx-loader": "3.0.0-rc.1", "@docusaurus/react-loadable": "5.5.2", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-common": "3.0.0-rc.0", - "@docusaurus/utils-validation": "3.0.0-rc.0", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-common": "3.0.0-rc.1", + "@docusaurus/utils-validation": "3.0.0-rc.1", "@slorber/static-site-generator-webpack-plugin": "^4.0.7", "@svgr/webpack": "^6.5.1", "autoprefixer": "^10.4.14", @@ -105,8 +105,8 @@ "webpackbar": "^5.0.2" }, "devDependencies": { - "@docusaurus/module-type-aliases": "3.0.0-rc.0", - "@docusaurus/types": "3.0.0-rc.0", + "@docusaurus/module-type-aliases": "3.0.0-rc.1", + "@docusaurus/types": "3.0.0-rc.1", "@types/detect-port": "^1.3.3", "@types/react-dom": "^18.2.7", "@types/react-router-config": "^5.0.7", diff --git a/packages/eslint-plugin/package.json b/packages/eslint-plugin/package.json index 4bc34b6365f3..c7d28c595be4 100644 --- a/packages/eslint-plugin/package.json +++ b/packages/eslint-plugin/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/eslint-plugin", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.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 5ac58eaad537..44283f022970 100644 --- a/packages/lqip-loader/package.json +++ b/packages/lqip-loader/package.json @@ -1,6 +1,6 @@ { "name": "@docusaurus/lqip-loader", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Low Quality Image Placeholders (LQIP) loader for webpack.", "main": "lib/index.js", "publishConfig": { @@ -17,7 +17,7 @@ }, "license": "MIT", "dependencies": { - "@docusaurus/logger": "3.0.0-rc.0", + "@docusaurus/logger": "3.0.0-rc.1", "file-loader": "^6.2.0", "lodash": "^4.17.21", "sharp": "^0.32.3", diff --git a/packages/stylelint-copyright/package.json b/packages/stylelint-copyright/package.json index 587116f2b77d..8626eded4057 100644 --- a/packages/stylelint-copyright/package.json +++ b/packages/stylelint-copyright/package.json @@ -1,6 +1,6 @@ { "name": "stylelint-copyright", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "description": "Stylelint plugin to check CSS files for a copyright header.", "main": "lib/index.js", "license": "MIT", diff --git a/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/index.mdx b/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/index.mdx index e7b9cca850f2..3190bf94f089 100644 --- a/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/index.mdx +++ b/website/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/index.mdx @@ -49,7 +49,7 @@ MDX v3 is much better, but also comes with changes that probably require you to Upgrading MDX comes with all the breaking changes documented on the [MDX v2](https://mdxjs.com/blog/v2/) and [MDX v3](https://mdxjs.com/blog/v3/) release blog posts. Most breaking changes come from MDX v2. The [MDX v2 migration guide](https://mdxjs.com/migrating/v2/) has a section on how to [update MDX files](https://mdxjs.com/migrating/v2/#update-mdx-files) that will be particularly relevant to us. Also make sure to read the [Troubleshooting MDX](https://mdxjs.com/docs/troubleshooting-mdx/) page that can help you interpret common MDX error messages. -Make sure to also read our updated [**MDX and React**](/docs/3.0.0-rc.0/markdown-features/react) documentation page. +Make sure to also read our updated [**MDX and React**](/docs/3.0.0-rc.1/markdown-features/react) documentation page. :::tip Ask for help @@ -214,14 +214,14 @@ http://localhost:3000 #### Lower-case MDXComponent mapping -For users providing a [custom `MDXComponent`mapping](/docs/3.0.0-rc.0/markdown-features/react#mdx-component-scope), components are now "sandboxed": +For users providing a [custom `MDXComponent`mapping](/docs/3.0.0-rc.1/markdown-features/react#mdx-component-scope), components are now "sandboxed": - a `MDXComponent` mapping for `h1` only gets used for `# hi` but not for `

hi

` - a **lower-cased** custom element name will not be substituted by its respective `MDXComponent` component anymore :::danger visual difference -Your [`MDXComponent` component mapping](/docs/3.0.0-rc.0/markdown-features/react#mdx-component-scope) might not be applied as before, and your custom components might no longer be used. +Your [`MDXComponent` component mapping](/docs/3.0.0-rc.1/markdown-features/react#mdx-component-scope) might not be applied as before, and your custom components might no longer be used. ::: diff --git a/website/docs/migration/v3.mdx b/website/docs/migration/v3.mdx index 833527b5b6e4..6e2c8babdd3c 100644 --- a/website/docs/migration/v3.mdx +++ b/website/docs/migration/v3.mdx @@ -291,7 +291,7 @@ For users providing a [custom `MDXComponent`mapping](../guides/markdown-features :::danger visual difference -Your [`MDXComponent` component mapping](/docs/3.0.0-rc.0/markdown-features/react#mdx-component-scope) might not be applied as before, and your custom components might no longer be used. +Your [`MDXComponent` component mapping](../guides/markdown-features/markdown-features-react.mdx#mdx-component-scope) might not be applied as before, and your custom components might no longer be used. ::: diff --git a/website/package.json b/website/package.json index 78fd8c0011fc..0b173837f981 100644 --- a/website/package.json +++ b/website/package.json @@ -1,6 +1,6 @@ { "name": "website", - "version": "3.0.0-rc.0", + "version": "3.0.0-rc.1", "private": true, "scripts": { "docusaurus": "docusaurus", @@ -36,19 +36,19 @@ "dependencies": { "@crowdin/cli": "^3.13.0", "@crowdin/crowdin-api-client": "^1.23.3", - "@docusaurus/core": "3.0.0-rc.0", - "@docusaurus/logger": "3.0.0-rc.0", - "@docusaurus/plugin-client-redirects": "3.0.0-rc.0", - "@docusaurus/plugin-ideal-image": "3.0.0-rc.0", - "@docusaurus/plugin-pwa": "3.0.0-rc.0", - "@docusaurus/preset-classic": "3.0.0-rc.0", - "@docusaurus/remark-plugin-npm2yarn": "3.0.0-rc.0", - "@docusaurus/theme-classic": "3.0.0-rc.0", - "@docusaurus/theme-common": "3.0.0-rc.0", - "@docusaurus/theme-live-codeblock": "3.0.0-rc.0", - "@docusaurus/theme-mermaid": "3.0.0-rc.0", - "@docusaurus/utils": "3.0.0-rc.0", - "@docusaurus/utils-common": "3.0.0-rc.0", + "@docusaurus/core": "3.0.0-rc.1", + "@docusaurus/logger": "3.0.0-rc.1", + "@docusaurus/plugin-client-redirects": "3.0.0-rc.1", + "@docusaurus/plugin-ideal-image": "3.0.0-rc.1", + "@docusaurus/plugin-pwa": "3.0.0-rc.1", + "@docusaurus/preset-classic": "3.0.0-rc.1", + "@docusaurus/remark-plugin-npm2yarn": "3.0.0-rc.1", + "@docusaurus/theme-classic": "3.0.0-rc.1", + "@docusaurus/theme-common": "3.0.0-rc.1", + "@docusaurus/theme-live-codeblock": "3.0.0-rc.1", + "@docusaurus/theme-mermaid": "3.0.0-rc.1", + "@docusaurus/utils": "3.0.0-rc.1", + "@docusaurus/utils-common": "3.0.0-rc.1", "@popperjs/core": "^2.11.8", "@swc/core": "1.2.197", "clsx": "^1.2.1", @@ -83,8 +83,8 @@ ] }, "devDependencies": { - "@docusaurus/eslint-plugin": "3.0.0-rc.0", - "@docusaurus/tsconfig": "3.0.0-rc.0", + "@docusaurus/eslint-plugin": "3.0.0-rc.1", + "@docusaurus/tsconfig": "3.0.0-rc.1", "@types/color": "^3.0.4", "@types/jest": "^29.5.3", "cross-env": "^7.0.3", diff --git a/website/versioned_docs/version-3.0.0-rc.0/advanced/architecture.mdx b/website/versioned_docs/version-3.0.0-rc.1/advanced/architecture.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/advanced/architecture.mdx rename to website/versioned_docs/version-3.0.0-rc.1/advanced/architecture.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/advanced/client.mdx b/website/versioned_docs/version-3.0.0-rc.1/advanced/client.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/advanced/client.mdx rename to website/versioned_docs/version-3.0.0-rc.1/advanced/client.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/advanced/index.mdx b/website/versioned_docs/version-3.0.0-rc.1/advanced/index.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/advanced/index.mdx rename to website/versioned_docs/version-3.0.0-rc.1/advanced/index.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/advanced/plugins.mdx b/website/versioned_docs/version-3.0.0-rc.1/advanced/plugins.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/advanced/plugins.mdx rename to website/versioned_docs/version-3.0.0-rc.1/advanced/plugins.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/advanced/routing.mdx b/website/versioned_docs/version-3.0.0-rc.1/advanced/routing.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/advanced/routing.mdx rename to website/versioned_docs/version-3.0.0-rc.1/advanced/routing.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/advanced/ssg.mdx b/website/versioned_docs/version-3.0.0-rc.1/advanced/ssg.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/advanced/ssg.mdx rename to website/versioned_docs/version-3.0.0-rc.1/advanced/ssg.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/docusaurus.config.js.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/docusaurus.config.js.mdx similarity index 99% rename from website/versioned_docs/version-3.0.0-rc.0/api/docusaurus.config.js.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/docusaurus.config.js.mdx index 3ef712b23067..ddb4e02bf965 100644 --- a/website/versioned_docs/version-3.0.0-rc.0/api/docusaurus.config.js.mdx +++ b/website/versioned_docs/version-3.0.0-rc.1/api/docusaurus.config.js.mdx @@ -459,7 +459,7 @@ export default { | `format` | `'mdx' \| 'md' \| 'detect'` | `'mdx'` | The default parser format to use for Markdown content. Using 'detect' will select the appropriate format automatically based on file extensions: `.md` vs `.mdx`. | | `mermaid` | `boolean` | `false` | When `true`, allows Docusaurus to render Markdown code blocks with `mermaid` language as Mermaid diagrams. | | `preprocessor` | `MarkdownPreprocessor` | `undefined` | Gives you the ability to alter the Markdown content string before parsing. Use it as a last-resort escape hatch or workaround: it is almost always better to implement a Remark/Rehype plugin. | -| `mdx1Compat` | `MDX1CompatOptions` | `{comments: true, admonitions: true, headingIds: true}` | Compatibility options to make it easier to upgrade to Docusaurus v3+. See the [MDX 2 PR for details](https://github.com/facebook/docusaurus/pull/8288). | +| `mdx1Compat` | `MDX1CompatOptions` | `{comments: true, admonitions: true, headingIds: true}` | Compatibility options to make it easier to upgrade to Docusaurus v3+. | ```mdx-code-block diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/_category_.yml b/website/versioned_docs/version-3.0.0-rc.1/api/misc/_category_.yml similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/_category_.yml rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/_category_.yml diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/create-docusaurus.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/misc/create-docusaurus.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/create-docusaurus.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/create-docusaurus.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/README.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/README.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/README.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/README.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/no-html-links.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/no-html-links.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/no-html-links.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/no-html-links.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/no-untranslated-text.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/no-untranslated-text.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/no-untranslated-text.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/no-untranslated-text.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/prefer-docusaurus-heading.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/string-literal-i18n-messages.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/string-literal-i18n-messages.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/eslint-plugin/string-literal-i18n-messages.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/eslint-plugin/string-literal-i18n-messages.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/logger/demo.png b/website/versioned_docs/version-3.0.0-rc.1/api/misc/logger/demo.png similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/logger/demo.png rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/logger/demo.png diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/misc/logger/logger.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/misc/logger/logger.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/misc/logger/logger.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/misc/logger/logger.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/README.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/README.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/README.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/README.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/_category_.yml b/website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/_category_.yml similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/_category_.yml rename to website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/_category_.yml diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/extend-infrastructure.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/extend-infrastructure.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/extend-infrastructure.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/extend-infrastructure.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/i18n-lifecycles.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/i18n-lifecycles.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/i18n-lifecycles.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/i18n-lifecycles.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/lifecycle-apis.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/lifecycle-apis.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/lifecycle-apis.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/lifecycle-apis.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/static-methods.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/static-methods.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugin-methods/static-methods.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugin-methods/static-methods.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/_category_.yml b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/_category_.yml similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/_category_.yml rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/_category_.yml diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/overview.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/overview.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/overview.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/overview.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-client-redirects.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-client-redirects.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-client-redirects.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-client-redirects.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-content-blog.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-content-blog.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-content-blog.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-content-blog.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-content-docs.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-content-docs.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-content-docs.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-content-docs.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-content-pages.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-content-pages.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-content-pages.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-content-pages.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-debug.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-debug.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-debug.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-google-analytics.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-google-analytics.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-google-analytics.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-google-analytics.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-google-gtag.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-google-gtag.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-google-gtag.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-google-gtag.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-google-tag-manager.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-google-tag-manager.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-google-tag-manager.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-google-tag-manager.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-ideal-image.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-ideal-image.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-ideal-image.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-ideal-image.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-pwa.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-pwa.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-pwa.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-pwa.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-sitemap.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-sitemap.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/plugins/plugin-sitemap.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/plugins/plugin-sitemap.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/themes/_category_.yml b/website/versioned_docs/version-3.0.0-rc.1/api/themes/_category_.yml similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/themes/_category_.yml rename to website/versioned_docs/version-3.0.0-rc.1/api/themes/_category_.yml diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/themes/overview.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/themes/overview.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/themes/overview.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/themes/overview.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-classic.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-classic.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-classic.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-classic.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-configuration.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-configuration.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-configuration.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-configuration.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-live-codeblock.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-live-codeblock.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-live-codeblock.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-live-codeblock.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-mermaid.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-mermaid.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-mermaid.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-mermaid.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-search-algolia.mdx b/website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-search-algolia.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/api/themes/theme-search-algolia.mdx rename to website/versioned_docs/version-3.0.0-rc.1/api/themes/theme-search-algolia.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/assets/docusaurus-asset-example-banner.png b/website/versioned_docs/version-3.0.0-rc.1/assets/docusaurus-asset-example-banner.png similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/assets/docusaurus-asset-example-banner.png rename to website/versioned_docs/version-3.0.0-rc.1/assets/docusaurus-asset-example-banner.png diff --git a/website/versioned_docs/version-3.0.0-rc.0/assets/docusaurus-asset-example.docx b/website/versioned_docs/version-3.0.0-rc.1/assets/docusaurus-asset-example.docx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/assets/docusaurus-asset-example.docx rename to website/versioned_docs/version-3.0.0-rc.1/assets/docusaurus-asset-example.docx diff --git a/website/versioned_docs/version-3.0.0-rc.0/assets/docusaurus-asset-example.xyz b/website/versioned_docs/version-3.0.0-rc.1/assets/docusaurus-asset-example.xyz similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/assets/docusaurus-asset-example.xyz rename to website/versioned_docs/version-3.0.0-rc.1/assets/docusaurus-asset-example.xyz diff --git a/website/versioned_docs/version-3.0.0-rc.0/blog.mdx b/website/versioned_docs/version-3.0.0-rc.1/blog.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/blog.mdx rename to website/versioned_docs/version-3.0.0-rc.1/blog.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/browser-support.mdx b/website/versioned_docs/version-3.0.0-rc.1/browser-support.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/browser-support.mdx rename to website/versioned_docs/version-3.0.0-rc.1/browser-support.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/cli.mdx b/website/versioned_docs/version-3.0.0-rc.1/cli.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/cli.mdx rename to website/versioned_docs/version-3.0.0-rc.1/cli.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/configuration.mdx b/website/versioned_docs/version-3.0.0-rc.1/configuration.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/configuration.mdx rename to website/versioned_docs/version-3.0.0-rc.1/configuration.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/deployment.mdx b/website/versioned_docs/version-3.0.0-rc.1/deployment.mdx similarity index 99% rename from website/versioned_docs/version-3.0.0-rc.0/deployment.mdx rename to website/versioned_docs/version-3.0.0-rc.1/deployment.mdx index b91958e73e24..e5a0df6f57f6 100644 --- a/website/versioned_docs/version-3.0.0-rc.0/deployment.mdx +++ b/website/versioned_docs/version-3.0.0-rc.1/deployment.mdx @@ -830,6 +830,8 @@ See [docs](https://docs.quantcdn.io/docs/cli/continuous-integration) and [blog]( [Azure Static Web Apps](https://docs.microsoft.com/en-us/azure/static-web-apps/overview) is a service that automatically builds and deploys full-stack web apps to Azure directly from the code repository, simplifying the developer experience for CI/CD. Static Web Apps separates the web application's static assets from its dynamic (API) endpoints. Static assets are served from globally-distributed content servers, making it faster for clients to retrieve files using servers nearby. Dynamic APIs are scaled with serverless architectures using an event-driven functions-based approach that is more cost-effective and scales on demand. Get started in a few minutes by following [this step-by-step guide](https://dev.to/azure/11-share-content-with-docusaurus-azure-static-web-apps-30hc). -## Deploying to Kinsta Application Hosting {#deploying-to-kinsta} +## Deploying to Kinsta {#deploying-to-kinsta} -[Kinsta Application Hosting](https://kinsta.com/application-hosting) is a service that lets you build and deploy your web apps directly from your Git repository. Get started in just a minutes by following our [Docusaurus on Kinsta](https://kinsta.com/help/docusaurus-example/) article. +[Kinsta Static Site Hosting](https://kinsta.com/static-site-hosting) lets you deploy up to 100 static sites for free, custom domains with SSL, 100 GB monthly bandwidth, and 260+ Cloudflare CDN locations. + +Get started in just a few clicks by following our [Docusaurus on Kinsta](https://kinsta.com/docs/docusaurus-example/) article. diff --git a/website/versioned_docs/version-3.0.0-rc.0/docusaurus-core.mdx b/website/versioned_docs/version-3.0.0-rc.1/docusaurus-core.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/docusaurus-core.mdx rename to website/versioned_docs/version-3.0.0-rc.1/docusaurus-core.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/creating-pages.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/creating-pages.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/creating-pages.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/creating-pages.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/docs-create-doc.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/docs-create-doc.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/docs-create-doc.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/docs-create-doc.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/docs-introduction.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/docs-introduction.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/docs-introduction.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/docs-introduction.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/docs-multi-instance.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/docs-multi-instance.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/docs-multi-instance.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/docs-multi-instance.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/autogenerated.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/autogenerated.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/autogenerated.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/autogenerated.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/index.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/index.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/index.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/items.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/items.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/items.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/items.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/multiple-sidebars.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/multiple-sidebars.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/sidebar/multiple-sidebars.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/sidebar/multiple-sidebars.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/docs/versioning.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/docs/versioning.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/docs/versioning.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/docs/versioning.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/_markdown-partial-example.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/_markdown-partial-example.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/_markdown-partial-example.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/_markdown-partial-example.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-admonitions.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-admonitions.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-admonitions.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-admonitions.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-assets.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-assets.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-assets.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-assets.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-code-blocks.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-code-blocks.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-code-blocks.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-code-blocks.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-diagrams.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-diagrams.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-diagrams.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-diagrams.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-head-metadata.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-head-metadata.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-head-metadata.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-head-metadata.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-intro.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-intro.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-intro.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-intro.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-links.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-links.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-links.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-links.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-math-equations.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-math-equations.mdx similarity index 96% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-math-equations.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-math-equations.mdx index 8fd3235148a6..efed943a5f89 100644 --- a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-math-equations.mdx +++ b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-math-equations.mdx @@ -54,12 +54,12 @@ $$ To enable KaTeX, you need to install `remark-math` and `rehype-katex` plugins. ```bash npm2yarn -npm install --save remark-math@5 rehype-katex@6 +npm install --save remark-math@6 rehype-katex@7 ``` :::warning -Make sure to use `remark-math >= 5` and `rehype-katex >= 6` for Docusaurus v3 (using MDX v2). +Make sure to use `remark-math 6` and `rehype-katex 7` for Docusaurus v3 (using MDX v3). We can't guarantee other versions will work. ::: diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-plugins.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-plugins.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-plugins.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-plugins.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-react.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-react.mdx similarity index 97% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-react.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-react.mdx index 9de7e414ef47..1aa05ba1734d 100644 --- a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-react.mdx +++ b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-react.mdx @@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem'; import styles from './markdown-features-react.module.css'; ``` -Docusaurus has built-in support for [MDX v2](https://mdxjs.com/), which allows you to write JSX within your Markdown files and render them as React components. +Docusaurus has built-in support for [MDX](https://mdxjs.com/), which allows you to write JSX within your Markdown files and render them as React components. Check out the [MDX docs](https://mdxjs.com/) to see what fancy stuff you can do with MDX. @@ -194,7 +194,7 @@ I can conveniently use Docusaurus green e We use **upper-case** tag names like `Highlight` on purpose. -From MDX v2+ onward (Docusaurus v3+), lower-case tag names are always rendered as native html elements, and will not use any component mapping you provide. +From MDX v3+ onward (Docusaurus v3+), lower-case tag names are always rendered as native html elements, and will not use any component mapping you provide. ::: @@ -227,7 +227,7 @@ If you don't wrap your imported MDX with `MDXContent`, the global scope will not ### Markdown and JSX interoperability {#markdown-and-jsx-interoperability} -Docusaurus v3 is using [MDX v2](https://mdxjs.com/blog/v2/). +Docusaurus v3 is using [MDX v3](https://mdxjs.com/blog/v3/). The [MDX syntax](https://mdxjs.com/docs/what-is-mdx/#mdx-syntax) is mostly compatible with [CommonMark](https://commonmark.org/), but is much stricter because your `.mdx` files can use JSX and are compiled into real React components (check the [playground](https://mdxjs.com/playground/)). diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-react.module.css b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-react.module.css similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-react.module.css rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-react.module.css diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-tabs-styles.module.css b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-tabs-styles.module.css similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-tabs-styles.module.css rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-tabs-styles.module.css diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-tabs.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-tabs.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-tabs.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-tabs.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-toc.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-toc.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/markdown-features/markdown-features-toc.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/markdown-features/markdown-features-toc.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/guides/whats-next.mdx b/website/versioned_docs/version-3.0.0-rc.1/guides/whats-next.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/guides/whats-next.mdx rename to website/versioned_docs/version-3.0.0-rc.1/guides/whats-next.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-crowdin.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-crowdin.mdx rename to website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-crowdin.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-git.mdx b/website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-git.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-git.mdx rename to website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-git.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-introduction.mdx b/website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-introduction.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-introduction.mdx rename to website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-introduction.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-tutorial.mdx b/website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-tutorial.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/i18n/i18n-tutorial.mdx rename to website/versioned_docs/version-3.0.0-rc.1/i18n/i18n-tutorial.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/installation.mdx b/website/versioned_docs/version-3.0.0-rc.1/installation.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/installation.mdx rename to website/versioned_docs/version-3.0.0-rc.1/installation.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/introduction.mdx b/website/versioned_docs/version-3.0.0-rc.1/introduction.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/introduction.mdx rename to website/versioned_docs/version-3.0.0-rc.1/introduction.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/migration/index.mdx b/website/versioned_docs/version-3.0.0-rc.1/migration/index.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/migration/index.mdx rename to website/versioned_docs/version-3.0.0-rc.1/migration/index.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-automated.mdx b/website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-automated.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-automated.mdx rename to website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-automated.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-manual.mdx b/website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-manual.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-manual.mdx rename to website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-manual.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-overview.mdx b/website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-overview.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-overview.mdx rename to website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-overview.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-translated-sites.mdx b/website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-translated-sites.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-translated-sites.mdx rename to website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-translated-sites.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-versioned-sites.mdx b/website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-versioned-sites.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/migration/v2/migration-versioned-sites.mdx rename to website/versioned_docs/version-3.0.0-rc.1/migration/v2/migration-versioned-sites.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/migration/v3.mdx b/website/versioned_docs/version-3.0.0-rc.1/migration/v3.mdx similarity index 81% rename from website/versioned_docs/version-3.0.0-rc.0/migration/v3.mdx rename to website/versioned_docs/version-3.0.0-rc.1/migration/v3.mdx index 3bb8a2ec87bc..6e2c8babdd3c 100644 --- a/website/versioned_docs/version-3.0.0-rc.0/migration/v3.mdx +++ b/website/versioned_docs/version-3.0.0-rc.1/migration/v3.mdx @@ -11,7 +11,7 @@ Docusaurus v3 is a new **major version**, including **breaking changes** requiri This is not a full rewrite, and the breaking changes are relatively easy to handle. The simplest sites will eventually upgrade by simply updating their npm dependencies. -The main breaking change is the [**upgrade to MDX v2**](https://mdxjs.com/blog/v2/), which will compile your Markdown content **more strictly** and with **subtle differences**. +The main breaking change is the upgrade from MDX v1 to MDX v3. Read the [**MDX v2**](https://mdxjs.com/blog/v2/) and [**MDX v3**](https://mdxjs.com/blog/v3/) release notes for details. MDX will now compile your Markdown content **more strictly** and with **subtle differences**. :::tip Before upgrading @@ -35,10 +35,11 @@ Docusaurus v3 now uses the following dependencies: - Node.js v18.0+ - React v18.0+ -- MDX v2.0+ +- MDX v3.0+ - TypeScript v5.0+ - prism-react-renderer v2.0+ - react-live v4.0+ +- remark-emoji v4.0+ - mermaid v10.4+ :::warning Upgrading community plugins @@ -61,7 +62,7 @@ A typical `package.json` dependency upgrade example: + "@docusaurus/preset-classic": "3.0.0", // upgrade to MDX v2 - "@mdx-js/react": "^1.6.22", -+ "@mdx-js/react": "^2.3.0", ++ "@mdx-js/react": "^3.0.0", // upgrade to prism-react-renderer v2.0+ - "prism-react-renderer": "^1.3.5", + "prism-react-renderer": "^2.1.0", @@ -108,7 +109,7 @@ For TypeScript users: MDX is a major dependency of Docusaurus responsible for compiling your `.md` and `.mdx` files to React components. -The transition from MDX v1 to MDX v2 is the **main challenge** to the adoption of Docusaurus v3. +The transition from MDX v1 to MDX v3 is the **main challenge** to the adoption of Docusaurus v3. Most breaking changes come from MDX v2, and MDX v3 is a relatively small release. Some documents that compiled successfully under Docusaurus v2 might now **fail to compile** under Docusaurus v3. @@ -128,7 +129,7 @@ For large sites where a manual review of all pages is complicated, we recommend ::: -Upgrading MDX comes with all the breaking changes documented on the [MDX v2 release blog post](https://mdxjs.com/blog/v2/). The [MDX v2 migration guide](https://mdxjs.com/migrating/v2/) has a section on how to [update MDX files](https://mdxjs.com/migrating/v2/#update-mdx-files) that will be particularly relevant to us. Also make sure to read the [Troubleshooting MDX](https://mdxjs.com/docs/troubleshooting-mdx/) page that can help you interpret common MDX error messages. +Upgrading MDX comes with all the breaking changes documented on the [MDX v2](https://mdxjs.com/blog/v2/) and [MDX v3](https://mdxjs.com/blog/v3/) release blog posts. Most breaking changes come from MDX v2. The [MDX v2 migration guide](https://mdxjs.com/migrating/v2/) has a section on how to [update MDX files](https://mdxjs.com/migrating/v2/#update-mdx-files) that will be particularly relevant to us. Also make sure to read the [Troubleshooting MDX](https://mdxjs.com/docs/troubleshooting-mdx/) page that can help you interpret common MDX error messages. Make sure to also read our updated [**MDX and React**](../guides/markdown-features/markdown-features-react.mdx) documentation page. @@ -136,21 +137,19 @@ Make sure to also read our updated [**MDX and React**](../guides/markdown-featur The MDX playground is your new best friend. It permits to understand how your content is **compiled to React components**, and troubleshoot compilation or rendering issues in isolation. -Each MDX version comes with its own playground: - -- [MDX v1 playground](https://mdx-git-renovate-babel-monorepo-mdx.vercel.app/playground/) -- [MDX v2 playground](https://mdxjs.com/playground/) +- [MDX playground - current version](https://mdxjs.com/playground/) +- [MDX playground - v1](https://mdx-git-renovate-babel-monorepo-mdx.vercel.app/playground/)
- Configuring the MDX v2 playground options for Docusaurus + Configuring the MDX playground options for Docusaurus -To obtain a compilation behavior similar to what Docusaurus v2 uses, please turn on these options on the [MDX v2 playground](https://mdxjs.com/playground/): +To obtain a compilation behavior similar to what Docusaurus v2 uses, please turn on these options on the [MDX playground](https://mdxjs.com/playground/): - Use `MDX` - Use `remark-gfm` - Use `remark-directive` -![Screenshot of the MDX v2 playground's options panel, with only the "Use `MDX`", "Use `remark-gfm`", and "Use `remark-directive`" options checked](@site/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/mdx2-playground-options.png) +![Screenshot of the MDX playground's options panel, with only the "Use `MDX`", "Use `remark-gfm`", and "Use `remark-directive`" options checked](@site/blog/2023-09-29-preparing-your-site-for-docusaurus-v3/img/mdx2-playground-options.png)
@@ -164,7 +163,7 @@ The goal will be to refactor your problematic content so that it **works fine wi ### Using the MDX checker CLI -We provide a [docusaurus-mdx-checker](https://github.com/slorber/docusaurus-mdx-checker) CLI that permits to easily spot problematic content. Run this command on your site to obtain a list of files that will fail to compile under MDX v2. +We provide a [docusaurus-mdx-checker](https://github.com/slorber/docusaurus-mdx-checker) CLI that permits to easily spot problematic content. Run this command on your site to obtain a list of files that will fail to compile under MDX v3. ```bash npx docusaurus-mdx-checker @@ -176,7 +175,7 @@ For each compilation issue, the CLI will log the file path and a line number to :::tip -Use this CLI to estimate of how much work will be required to make your content compatible with MDX v2. +Use this CLI to estimate of how much work will be required to make your content compatible with MDX v3. ::: @@ -190,13 +189,13 @@ It will not report subtle compilation changes that do not produce errors but can ### Common MDX problems -Docusaurus cannot document exhaustively all the changes coming with MDX v2. That's the responsibility of the [MDX v2 migration guide](https://mdxjs.com/migrating/v2/). +Docusaurus cannot document exhaustively all the changes coming with MDX. That's the responsibility of the [MDX v2](https://mdxjs.com/migrating/v2/) and [MDX v3](https://mdxjs.com/migrating/v3/) migration guides. However, by upgrading a few Docusaurus sites, we noticed that most of the issues come down to only a few cases that we have documented for you. #### Bad usage of `{` -The `{` character is used for opening [JavaScript expressions](https://mdxjs.com/docs/what-is-mdx/#expressions). MDX v2 will now fail if what you put inside `{expression}` is not a valid expression. +The `{` character is used for opening [JavaScript expressions](https://mdxjs.com/docs/what-is-mdx/#expressions). MDX will now fail if what you put inside `{expression}` is not a valid expression. ```md title="example.md" The object shape looks like {username: string, age: number} @@ -220,7 +219,7 @@ Available options to fix this error: #### Bad usage of `<` -The `<` character is used for opening [JSX tags](https://mdxjs.com/docs/what-is-mdx/#jsx). MDX v2 will now fail if it thinks your JSX is invalid. +The `<` character is used for opening [JSX tags](https://mdxjs.com/docs/what-is-mdx/#jsx). MDX will now fail if it thinks your JSX is invalid. ```md title="example.md" Use Android version <5 @@ -252,7 +251,7 @@ Available options to fix this error: #### Bad usage of GFM Autolink -Docusaurus supports [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/), but [autolink](https://github.github.com/gfm/#autolinks) using the `` syntax is not supported anymore by MDX v2. +Docusaurus supports [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/), but [autolink](https://github.github.com/gfm/#autolinks) using the `` syntax is not supported anymore by MDX. ```md title="example.md" @@ -292,7 +291,7 @@ For users providing a [custom `MDXComponent`mapping](../guides/markdown-features :::danger visual difference -Your [`MDXComponent` component mapping](/docs/3.0.0-rc.0/markdown-features/react#mdx-component-scope) might not be applied as before, and your custom components might no longer be used. +Your [`MDXComponent` component mapping](../guides/markdown-features/markdown-features-react.mdx#mdx-component-scope) might not be applied as before, and your custom components might no longer be used. ::: @@ -317,11 +316,11 @@ For any other element, **use upper-case names**. #### Unintended extra paragraphs -In MDX v2, it is now possible to interleave JSX and Markdown more easily without requiring extra line breaks. Writing content on multiple lines can also produce new expected `

` tags. +In MDX v3, it is now possible to interleave JSX and Markdown more easily without requiring extra line breaks. Writing content on multiple lines can also produce new expected `

` tags. :::danger visual difference -See how this content is rendered differently by MDX v1 and v2. +See how this content is rendered differently by MDX v1 and v3. ```md title="example.md"

Some **Markdown** content
@@ -337,7 +336,7 @@ See how this content is rendered differently by MDX v1 and v2. ``` {/* prettier-ignore */} -```html title="MDX v2 output" +```html title="MDX v3 output"
Some Markdown content

Some Markdown content

``` @@ -403,7 +402,7 @@ conf is great #### Unsupported indented code blocks -MDX v2 does not transform indented text as code blocks anymore. +MDX does not transform indented text as code blocks anymore. ```md title="example.md" console.log("hello"); @@ -411,7 +410,7 @@ MDX v2 does not transform indented text as code blocks anymore. :::danger Visual change -The upgrade does not generally produce new MDX v2 compilation errors, but can lead to content being rendered in an unexpected way because there isn't a code block anymore. +The upgrade does not generally produce new MDX compilation errors, but can lead to content being rendered in an unexpected way because there isn't a code block anymore. ::: @@ -467,7 +466,7 @@ If you created custom Remark or Rehype plugins, you may need to refactor those, ## Other Breaking Changes -Apart the MDX v2 upgrade, here is an exhaustive list of breaking changes coming with Docusaurus v3. +Apart the MDX v3 upgrade, here is an exhaustive list of breaking changes coming with Docusaurus v3. ### Node.js v18.0 @@ -578,6 +577,18 @@ However, this is a new major library version containing breaking changes, and we ::: +### remark-emoji v4.0+ + +Docusaurus v3 upgrades [`prism-react-renderer`](https://github.com/rhysd/remark-emoji) to v4.0+. This library is to support `:emoji:` shortcuts in Markdown. + +:::info How to upgrade + +Most Docusaurus users have nothing to do. Users of emoji shortcodes should read the [changelog](https://github.com/rhysd/remark-emoji/blob/master/CHANGELOG.md) and double-check their emojis keep rendering as expected. + +> **Breaking Change** Update [node-emoji](https://www.npmjs.com/package/node-emoji) from v1 to v2. This change introduces support for many new emojis and removes old emoji short codes which are no longer valid on GitHub. + +::: + ### Mermaid v10.4+ For users of the `@docusaurus/theme-mermaid` package, Docusaurus v3 upgrades [`mermaid`](https://github.com/mermaid-js/mermaid) to v10.4+. @@ -800,11 +811,90 @@ We recommend using the `.mdx` extension whenever you use JSX, `import`, or `expo In future versions of Docusaurus, `.md` files will be parsed as standard [CommonMark](https://commonmark.org/), which does not support these features. In Docusaurus v3, `.md` files keep being compiled as MDX files, but it will be possible to [opt-in for CommonMark](https://github.com/facebook/docusaurus/issues/3018). +### Upgrading math packages + +If you use Docusaurus to render [Math Equations](../guides/markdown-features/markdown-features-math-equations.mdx), you should upgrade the MDX plugins. + +Make sure to use `remark-math 6` and `rehype-katex 7` for Docusaurus v3 (using MDX v3). We can't guarantee other versions will work. + +```diff package.json +{ +- "remark-math": "^3.0.0", ++ "remark-math": "^6.0.0", +- "rehype-katex": "^5.0.0" ++ "rehype-katex": "^7.0.0" +} +``` + +### Turn off MDX v1 compat + +Docusaurus v3 comes with [MDX v1 compatibility options](../api/docusaurus.config.js.mdx#markdown), that are turned on by default. + +```js title="docusaurus.config.js" +export default { + markdown: { + mdx1Compat: { + comments: true, + admonitions: true, + headingIds: true, + }, + }, +}; +``` + +#### `comments` option + +This option allows the usage of HTML comments inside MDX, while HTML comments are officially not supported anymore. + +For MDX files, we recommend to progressively use MDX `{/* comments */}` instead of HTML ``, and then turn this compatibility option off. + +:::info Blog truncate marker + +The default blog truncate marker now supports both `` and `{/* truncate */}`. + +::: + +#### `admonitions` option + +This option allows the usage of the Docusaurus v2 [admonition title](../guides/markdown-features/markdown-features-admonitions.mdx#specifying-title) syntax: + +```md +:::note Your Title + +content + +::: +``` + +Docusaurus now implements admonitions with [Markdown Directives](https://talk.commonmark.org/t/generic-directives-plugins-syntax/444) (implemented with [remark-directive](https://github.com/remarkjs/remark-directive)), and the syntax to provide a directive label requires square brackets: + +```md +:::note[Your Title] + +content + +::: +``` + +We recommend to progressively use the new Markdown directive label syntax, and then turn this compatibility option off. + +#### `headingIds` option + +This option allows the usage of the Docusaurus v2 [explicit heading id](../guides/markdown-features/markdown-features-toc.mdx#heading-ids) syntax: + +```mdx-code-block +{'### Hello World \u007B#my-explicit-id}\n'} +``` + +This syntax is now invalid MDX, and would require to escape the `{` character: `\{#my-explicit-id}`. + +We recommend to keep this compatibility option on for now, until we provide a new syntax compatible with newer versions of MDX. + ## Ask For Help In case of any upgrade problem, the first things to try are: -- make sure all your docs compile in the [MDX v2 playground](https://mdxjs.com/playground/), or using [`npx docusaurus-mdx-checker`](https://github.com/slorber/docusaurus-mdx-checker) +- make sure all your docs compile in the [MDX playground](https://mdxjs.com/playground/), or using [`npx docusaurus-mdx-checker`](https://github.com/slorber/docusaurus-mdx-checker) - delete `node_modules` and run `npm install` again - run `docusaurus clear` to clear the caches - remove third-party plugins that might not support Docusaurus v3 @@ -814,9 +904,9 @@ Once you have tried that, you can ask for support through the following support - [Docusaurus v3 - Upgrade Support](https://github.com/facebook/docusaurus/discussions/9336) - [Docusaurus v3 - Discord channel #migration-v2-to-v3](https://discord.com/channels/398180168688074762/1154771869094912090) -- [MDX v2 - Upgrade Support](https://github.com/facebook/docusaurus/discussions/9053) -- [MDX v2 - Remark/Rehype Plugins Support](https://github.com/facebook/docusaurus/discussions/9337) -- [MDX v2 - Discord channel #migration-mdx-v2](https://discord.com/channels/398180168688074762/1116724556976111616) +- [MDX v3 - Upgrade Support](https://github.com/facebook/docusaurus/discussions/9053) +- [MDX v3 - Remark/Rehype Plugins Support](https://github.com/facebook/docusaurus/discussions/9337) +- [MDX v3 - Discord channel #migration-mdx-v3](https://discord.com/channels/398180168688074762/1116724556976111616) Please consider **our time is precious**. To ensure that your support request is not ignored, we kindly ask you to: diff --git a/website/versioned_docs/version-3.0.0-rc.0/playground.mdx b/website/versioned_docs/version-3.0.0-rc.1/playground.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/playground.mdx rename to website/versioned_docs/version-3.0.0-rc.1/playground.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/search.mdx b/website/versioned_docs/version-3.0.0-rc.1/search.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/search.mdx rename to website/versioned_docs/version-3.0.0-rc.1/search.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/seo.mdx b/website/versioned_docs/version-3.0.0-rc.1/seo.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/seo.mdx rename to website/versioned_docs/version-3.0.0-rc.1/seo.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/static-assets.mdx b/website/versioned_docs/version-3.0.0-rc.1/static-assets.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/static-assets.mdx rename to website/versioned_docs/version-3.0.0-rc.1/static-assets.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/styling-layout.mdx b/website/versioned_docs/version-3.0.0-rc.1/styling-layout.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/styling-layout.mdx rename to website/versioned_docs/version-3.0.0-rc.1/styling-layout.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/swizzling.mdx b/website/versioned_docs/version-3.0.0-rc.1/swizzling.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/swizzling.mdx rename to website/versioned_docs/version-3.0.0-rc.1/swizzling.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/typescript-support.mdx b/website/versioned_docs/version-3.0.0-rc.1/typescript-support.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/typescript-support.mdx rename to website/versioned_docs/version-3.0.0-rc.1/typescript-support.mdx diff --git a/website/versioned_docs/version-3.0.0-rc.0/using-plugins.mdx b/website/versioned_docs/version-3.0.0-rc.1/using-plugins.mdx similarity index 100% rename from website/versioned_docs/version-3.0.0-rc.0/using-plugins.mdx rename to website/versioned_docs/version-3.0.0-rc.1/using-plugins.mdx diff --git a/website/versioned_sidebars/version-3.0.0-rc.0-sidebars.json b/website/versioned_sidebars/version-3.0.0-rc.1-sidebars.json similarity index 100% rename from website/versioned_sidebars/version-3.0.0-rc.0-sidebars.json rename to website/versioned_sidebars/version-3.0.0-rc.1-sidebars.json diff --git a/website/versions.json b/website/versions.json index 7c5ed9953e59..a5a0c48297fc 100644 --- a/website/versions.json +++ b/website/versions.json @@ -1,5 +1,5 @@ [ - "3.0.0-rc.0", + "3.0.0-rc.1", "2.4.3", "2.3.1", "2.2.0",