Skip to content

Commit 85f2033

Browse files
Improve Code
1 parent aafd1d4 commit 85f2033

3 files changed

Lines changed: 39 additions & 271 deletions

File tree

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you wanna help, see [Contributing](CONTRIBUTING.md).
2727

2828
This website is built using [Docusaurus](https://docusaurus.io/).
2929

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`).
3131

3232
## Installing Project Dependencies
3333

@@ -52,6 +52,7 @@ npm run build
5252
```
5353

5454
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.
5556

5657
## Deployment
5758

@@ -70,8 +71,8 @@ There are many ways to update your Docusaurus version. One guaranteed way is to
7071
```
7172
{
7273
"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",
7576
// ...
7677
}
7778
}
@@ -90,3 +91,11 @@ npx docusaurus --version
9091
```
9192

9293
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.

package-lock.json

Lines changed: 25 additions & 267 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"scripts": {
66
"docusaurus": "docusaurus",
77
"start": "docusaurus start",
8-
"build": "docusaurus build",
8+
"build": "cross-env NO_UPDATE_NOTIFIER=1 docusaurus build",
99
"swizzle": "docusaurus swizzle",
1010
"deploy": "docusaurus deploy",
1111
"clear": "docusaurus clear",
@@ -28,6 +28,7 @@
2828
"@docusaurus/module-type-aliases": "3.10.1",
2929
"@docusaurus/tsconfig": "3.10.1",
3030
"@docusaurus/types": "3.10.1",
31+
"cross-env": "^10.1.0",
3132
"typescript": "~5.2.2"
3233
},
3334
"browserslist": {

0 commit comments

Comments
 (0)