Skip to content

Commit 9ecbb1f

Browse files
committed
Upgrade to Docusaurus V3
1 parent febff99 commit 9ecbb1f

File tree

8 files changed

+6742
-5243
lines changed

8 files changed

+6742
-5243
lines changed

.changeset/clean-rules-drop.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'docusaurus-plugin-redoc': major
3+
'docusaurus-theme-redoc': major
4+
'redocusaurus': major
5+
---
6+
7+
Upgrade to Docusaurus V3

packages/docusaurus-plugin-redoc/package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@
2929
},
3030
"homepage": "https://github.com/rohit-gohri/redocusaurus/tree/main/packages/docusaurus-plugin-redoc#readme",
3131
"dependencies": {
32-
"@redocly/openapi-core": "1.0.0-beta.123",
33-
"redoc": "2.0.0"
32+
"@redocly/openapi-core": "1.4.0",
33+
"redoc": "2.1.3"
3434
},
3535
"devDependencies": {
36-
"@docusaurus/types": "^2.3.1",
37-
"@docusaurus/utils": "^2.3.1"
36+
"@docusaurus/types": "^3.0.0",
37+
"@docusaurus/utils": "^3.0.0"
3838
},
3939
"peerDependencies": {
40-
"@docusaurus/utils": "^2.0.0"
40+
"@docusaurus/utils": "^3.0.0"
4141
},
4242
"engines": {
4343
"node": ">=14"

packages/docusaurus-theme-redoc/package.json

+10-9
Original file line numberDiff line numberDiff line change
@@ -32,28 +32,29 @@
3232
},
3333
"homepage": "https://github.com/rohit-gohri/redocusaurus/tree/main/packages/docusaurus-theme-redoc#readme",
3434
"dependencies": {
35-
"@redocly/openapi-core": "1.0.0-beta.123",
35+
"@redocly/openapi-core": "1.4.0",
3636
"clsx": "^1.2.1",
3737
"copyfiles": "^2.4.1",
3838
"lodash": "^4.17.21",
3939
"mobx": "^6.8.0",
40-
"redoc": "2.0.0",
40+
"redoc": "2.1.3",
4141
"styled-components": "^5.3.6"
4242
},
4343
"devDependencies": {
44-
"@docusaurus/module-type-aliases": "^2.3.1",
45-
"@docusaurus/theme-classic": "^2.3.1",
46-
"@docusaurus/theme-common": "^2.3.1",
47-
"@docusaurus/types": "^2.3.1",
44+
"@docusaurus/module-type-aliases": "^3.0.0",
45+
"@docusaurus/theme-classic": "^3.0.0",
46+
"@docusaurus/theme-common": "^3.0.0",
47+
"@docusaurus/types": "^3.0.0",
4848
"@types/lodash": "^4.14.191",
49-
"@types/react-dom": "^17.0.18",
49+
"@types/react": "^18.2.34",
50+
"@types/react-dom": "^18.2.14",
5051
"@types/react-router-dom": "^5.3.3",
5152
"@types/styled-components": "^5.1.26",
5253
"nodemon": "^2.0.20",
53-
"typescript": "^4.9.5"
54+
"typescript": "^5.2.2"
5455
},
5556
"peerDependencies": {
56-
"@docusaurus/theme-common": "^2.0.0"
57+
"@docusaurus/theme-common": "^3.0.0"
5758
},
5859
"engines": {
5960
"node": ">=14"
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,6 @@
11
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
22

33
if (ExecutionEnvironment.canUseDOM) {
4-
/**
5-
* @see https://github.com/rohit-gohri/redocusaurus/issues/89#issuecomment-942256382
6-
*/
7-
// @ts-expect-error prism global
84
window.Prism = window.Prism || {};
9-
// @ts-expect-error prism global
105
window.Prism.manual = true;
116
}

packages/redocusaurus/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@
4545
"docusaurus-theme-redoc": "1.6.4"
4646
},
4747
"peerDependencies": {
48-
"@docusaurus/theme-common": "^2.0.0",
49-
"@docusaurus/utils": "^2.0.0"
48+
"@docusaurus/theme-common": "^3.0.0",
49+
"@docusaurus/utils": "^3.0.0"
5050
},
5151
"engines": {
5252
"node": ">=14"

website/docs/getting-started/Installation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Pass options to customize the theme, see [theme options](./theme-options.md) for
100100
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.
101101
102102
Example: [redocly.yaml](https://github.com/rohit-gohri/redocusaurus/blob/main/website/redocly.yaml)
103-
Reference: <https://redocly.com/docs/cli/configuration/>. Only supports options marked as "Supported in Redoc CE".
103+
Reference: [https://redocly.com/docs/cli/configuration/](https://redocly.com/docs/cli/configuration/). Only supports options marked as "Supported in Redoc CE".
104104
105105
:::important
106106
When setting the `redocly.yaml` config, you website renders correctly only once it is built and run with the following commands:

website/package.json

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,16 @@
2222
"test": "percy snapshot snapshots.js"
2323
},
2424
"dependencies": {
25-
"@docusaurus/core": "^2.3.1",
26-
"@docusaurus/preset-classic": "^2.3.1",
25+
"@docusaurus/core": "^3.0.0",
26+
"@docusaurus/preset-classic": "^3.0.0",
2727
"clsx": "^1.2.1",
28-
"react": "^17.0.2",
29-
"react-dom": "^17.0.2",
28+
"react": "^18.0.0",
29+
"react-dom": "^18.0.0",
3030
"redocusaurus": "^1.6.4"
3131
},
3232
"devDependencies": {
3333
"@percy/cli": "^1.18.0",
34-
"@types/react": "^17.0.53"
34+
"@types/react": "^18.0.0"
3535
},
3636
"browserslist": {
3737
"production": [

0 commit comments

Comments
 (0)