Skip to content

Commit cf0e610

Browse files
authored
[Document-4521] Fix build documentation (#4522)
1 parent 784989a commit cf0e610

4 files changed

Lines changed: 13 additions & 225 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ jobs:
2727
- uses: actions/checkout@v3
2828
- name: Build documentation
2929
run: |
30-
cd docs && npm install --prefer-offline --no-audit --progress=false --legacy-peer-deps \
31-
&& npm run build
30+
cd docs && pnpm install && pnpm run build
3231
- name: Upload documentation
3332
uses: burnett01/rsync-deployments@5.2
3433
with:

docs/README.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,32 @@
44

55
## 条件
66

7-
Dinky 网站基于 Docusaurus 。如果您的 Docusaurus 版本低于 2.2.0,请升级到 2.2.0。另请确保您的Node版本为 18+。
7+
Dinky 网站基于 Docusaurus 。如果您的 Docusaurus 版本低于 3.9.2,请升级到 3.9.2。另请确保您的Node版本为 18+。
88

99
### 安装
1010

1111
```shell
12-
yarn
13-
或者
14-
npm install --prefer-offline --no-audit --progress=false --legacy-peer-deps --registry https://repo.huaweicloud.com/repository/npm/
15-
12+
pnpm install
1613
```
1714
### 本地启动
1815

1916
```shell
20-
yarn start
21-
或者
22-
npm run start
23-
或者
24-
npx docusaurus start [--port 3111 ] [--host localhost ]
17+
pnpm run start
2518
```
2619
默认端口为 3000
2720

2821
此命令启动本地开发服务器并打开浏览器窗口。大多数更改都会实时预览,而无需重新启动服务器。
2922

3023
### 编译
3124

32-
```
33-
yarn build
34-
或者
35-
npm run build
25+
```shell
26+
pnpm run build
3627
```
3728

3829

3930
## 生成新版本
4031
```shell
41-
npm run docusaurus docs:version 0.7
32+
pnpm run docusaurus docs:version 0.7
4233
```
4334

4435
## 生成国际化json

docs/docs/practical_guide/run_mode_practice/dinky_k8s_quick_start.mdx

Lines changed: 0 additions & 202 deletions
This file was deleted.

docs/package.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
"write-heading-ids": "docusaurus write-heading-ids --overwrite"
1616
},
1717
"dependencies": {
18-
"@docusaurus/core": "3.8.1",
19-
"@docusaurus/plugin-ideal-image": "^3.8.1",
20-
"@docusaurus/preset-classic": "3.8.1",
18+
"@docusaurus/core": "3.9.2",
19+
"@docusaurus/plugin-ideal-image": "^3.9.2",
20+
"@docusaurus/preset-classic": "3.9.2",
2121
"@easyops-cn/docusaurus-search-local": "^0.52.1",
2222
"@mdx-js/react": "^3.0.0",
2323
"clsx": "^2.0.0",
@@ -29,9 +29,9 @@
2929
"sharp": "^0.34.3"
3030
},
3131
"devDependencies": {
32-
"@docusaurus/module-type-aliases": "3.8.1",
33-
"@docusaurus/tsconfig": "3.8.1",
34-
"@docusaurus/types": "3.8.1",
32+
"@docusaurus/module-type-aliases": "3.9.2",
33+
"@docusaurus/tsconfig": "3.9.2",
34+
"@docusaurus/types": "3.9.2",
3535
"less": "^4.4.1",
3636
"typescript": "~5.6.2"
3737
},

0 commit comments

Comments
 (0)