You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-3Lines changed: 12 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,7 +27,7 @@ If you wanna help, see [Contributing](CONTRIBUTING.md).
27
27
28
28
This website is built using [Docusaurus](https://docusaurus.io/).
29
29
30
-
-[Node.js](https://nodejs.org/en) version 18.0 or above (which can be checked by running `node -v`).
30
+
-[Node.js](https://nodejs.org/en) version 20.0 or above (which can be checked by running `node -v`).
31
31
32
32
## Installing Project Dependencies
33
33
@@ -52,6 +52,7 @@ npm run build
52
52
```
53
53
54
54
This command generates static content into the `build` directory and can be served using any static contents hosting service.
55
+
It also disables the Docusaurus update notifier for the build command, so local permission issues in the update-check config store do not pollute build output.
55
56
56
57
## Deployment
57
58
@@ -70,8 +71,8 @@ There are many ways to update your Docusaurus version. One guaranteed way is to
70
71
```
71
72
{
72
73
"dependencies": {
73
-
"@docusaurus/core": "3.1.0",
74
-
"@docusaurus/preset-classic": "3.1.0",
74
+
"@docusaurus/core": "3.10.1",
75
+
"@docusaurus/preset-classic": "3.10.1",
75
76
// ...
76
77
}
77
78
}
@@ -90,3 +91,11 @@ npx docusaurus --version
90
91
```
91
92
92
93
You should see the correct version as output.
94
+
95
+
## Docusaurus v4 Readiness
96
+
97
+
Docusaurus 3.10 is the last v3 line and includes opt-in behavior that prepares sites for v4. Keep these as separate, deliberate follow-up tasks:
98
+
99
+
-`future.v4.siteStorageNamespacing`: test `storage: { type: 'localStorage', namespace: true }` in a browser before enabling it, because it changes localStorage keys used by color mode and language tabs.
100
+
-`future.v4.fasterByDefault`: do not enable this in the regular upgrade path yet. `future.faster` currently requires an additional v4 future flag in this project, so test it in a dedicated v4-prep branch.
101
+
-`future.v4.mdx1CompatDisabledByDefault`: keep `markdown.mdx1Compat` enabled until docs are audited for strict MDX syntax.
0 commit comments