Merge pull request #314 from zabomate/docusaurus_v3

Upgrade to Docusaurus V3

.changeset/clean-rules-drop.md

@@ -0,0 +1,7 @@
+---
+'docusaurus-plugin-redoc': major
+'docusaurus-theme-redoc': major
+'redocusaurus': major
+---
+
+Upgrade to Docusaurus V3

.github/workflows/build.yml

@@ -25,7 +25,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
           cache: 'yarn'
 
       - name: Install Dependencies 📦
@@ -60,7 +60,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
           cache: 'yarn'
           registry-url: 'https://registry.npmjs.org'
 

.github/workflows/e2e.yml

@@ -25,7 +25,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
           cache: 'yarn'
 
       - name: Install Dependencies 📦

.github/workflows/version.yml

@@ -26,7 +26,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
           cache: 'yarn'
           registry-url: https://registry.npmjs.org/
 
@@ -57,7 +57,7 @@ jobs:
 
       - uses: actions/setup-node@v3
         with:
-          node-version: '16'
+          node-version: '18'
           cache: 'yarn'
           registry-url: https://registry.npmjs.org/
 

packages/docusaurus-plugin-redoc/package.json

@@ -29,15 +29,15 @@
   },
   "homepage": "https://github.com/rohit-gohri/redocusaurus/tree/main/packages/docusaurus-plugin-redoc#readme",
   "dependencies": {
-    "@redocly/openapi-core": "1.0.0-beta.123",
-    "redoc": "2.0.0"
+    "@redocly/openapi-core": "1.4.0",
+    "redoc": "2.1.3"
   },
   "devDependencies": {
-    "@docusaurus/types": "^2.3.1",
-    "@docusaurus/utils": "^2.3.1"
+    "@docusaurus/types": "^3.0.0",
+    "@docusaurus/utils": "^3.0.0"
   },
   "peerDependencies": {
-    "@docusaurus/utils": "^2.0.0"
+    "@docusaurus/utils": "^3.0.0"
   },
   "engines": {
     "node": ">=14"

packages/docusaurus-theme-redoc/package.json

@@ -32,28 +32,29 @@
   },
   "homepage": "https://github.com/rohit-gohri/redocusaurus/tree/main/packages/docusaurus-theme-redoc#readme",
   "dependencies": {
-    "@redocly/openapi-core": "1.0.0-beta.123",
+    "@redocly/openapi-core": "1.4.0",
     "clsx": "^1.2.1",
     "copyfiles": "^2.4.1",
     "lodash": "^4.17.21",
     "mobx": "^6.8.0",
-    "redoc": "2.0.0",
+    "redoc": "2.1.3",
     "styled-components": "^5.3.6"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "^2.3.1",
-    "@docusaurus/theme-classic": "^2.3.1",
-    "@docusaurus/theme-common": "^2.3.1",
-    "@docusaurus/types": "^2.3.1",
+    "@docusaurus/module-type-aliases": "^3.0.0",
+    "@docusaurus/theme-classic": "^3.0.0",
+    "@docusaurus/theme-common": "^3.0.0",
+    "@docusaurus/types": "^3.0.0",
     "@types/lodash": "^4.14.191",
-    "@types/react-dom": "^17.0.18",
+    "@types/react": "^18.2.34",
+    "@types/react-dom": "^18.2.14",
     "@types/react-router-dom": "^5.3.3",
     "@types/styled-components": "^5.1.26",
     "nodemon": "^2.0.20",
-    "typescript": "^4.9.5"
+    "typescript": "^5.2.2"
   },
   "peerDependencies": {
-    "@docusaurus/theme-common": "^2.0.0"
+    "@docusaurus/theme-common": "^3.0.0"
   },
   "engines": {
     "node": ">=14"

packages/docusaurus-theme-redoc/src/global.ts

@@ -1,11 +1,6 @@
 import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
 
 if (ExecutionEnvironment.canUseDOM) {
-  /**
-   * @see https://github.com/rohit-gohri/redocusaurus/issues/89#issuecomment-942256382
-   */
-  // @ts-expect-error prism global
   window.Prism = window.Prism || {};
-  // @ts-expect-error prism global
   window.Prism.manual = true;
 }

packages/redocusaurus/package.json

@@ -45,8 +45,8 @@
     "docusaurus-theme-redoc": "1.6.4"
   },
   "peerDependencies": {
-    "@docusaurus/theme-common": "^2.0.0",
-    "@docusaurus/utils": "^2.0.0"
+    "@docusaurus/theme-common": "^3.0.0",
+    "@docusaurus/utils": "^3.0.0"
   },
   "engines": {
     "node": ">=14"

website/docs/getting-started/Installation.md

@@ -100,7 +100,7 @@ Pass options to customize the theme, see [theme options](./theme-options.md) for
 Redocly config to bundle file and provide options to. You can provide a custom path to a `redocly.yaml` file, if not provided then it will try to load it from the root of your project if it exists.
 
 Example: [redocly.yaml](https://github.com/rohit-gohri/redocusaurus/blob/main/website/redocly.yaml)
-Reference: <https://redocly.com/docs/cli/configuration/>. Only supports options marked as "Supported in Redoc CE".
+Reference: [https://redocly.com/docs/cli/configuration/](https://redocly.com/docs/cli/configuration/). Only supports options marked as "Supported in Redoc CE".
 
 :::important
 When setting the `redocly.yaml` config, you website renders correctly only once it is built and run with the following commands:

website/package.json

@@ -22,16 +22,16 @@
     "test": "percy snapshot snapshots.js"
   },
   "dependencies": {
-    "@docusaurus/core": "^2.3.1",
-    "@docusaurus/preset-classic": "^2.3.1",
+    "@docusaurus/core": "^3.0.0",
+    "@docusaurus/preset-classic": "^3.0.0",
     "clsx": "^1.2.1",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0",
     "redocusaurus": "^1.6.4"
   },
   "devDependencies": {
     "@percy/cli": "^1.18.0",
-    "@types/react": "^17.0.53"
+    "@types/react": "^18.0.0"
   },
   "browserslist": {
     "production": [