本网站使用 Docusaurus 构建。
npm install
rd /s /q .docusaurus
rd /s /q build
npm run build
此命令会将静态内容生成到 build
目录中,可以使用任何静态内容托管服务进行部署。
npm run serve
如果没有自动启动浏览器进入网站,可以手动在浏览器中访问 http://localhost:3000 查看文档页面。
⚠️ 如需本地多语言预览,推荐使用npm run serve
,npm start
在部分环境下可能无法正常切换语言。
npm run serve
:预览已构建好的静态网站(build 目录),不支持热重载,适合本地预览生产效果。npm start
:启动开发服务器,支持热重载,适合本地开发和调试。
项目已配置了 VS Code 任务,可以一键完成构建和启动:
- 快捷键方式:按
Ctrl+Shift+B
,选择 "Docusaurus Build and Serve" - 命令面板方式:按
Ctrl+Shift+P
,输入 "Tasks: Run Task",选择 "Docusaurus Build and Serve" - Task Button 方式:如果安装了 Task Button 扩展,左下角会显示 🚀 Docusaurus 按钮,点击即可运行
npm run build && npm run serve
本项目支持中英文双语,使用 Docusaurus 官方 i18n 功能。
- 英文内容:位于
docs/
目录 - 中文内容:位于
i18n/zh-Hans/docusaurus-plugin-content-docs/current/
目录 - 侧边栏本地化:通过 JSON 翻译文件实现,而非独立的 sidebars.js
Docusaurus 官方推荐使用 JSON 翻译文件来本地化侧边栏分组名:
-
生成翻译文件:
npm run write-translations -- --locale zh-Hans
-
修改翻译内容:编辑
i18n/zh-Hans/docusaurus-plugin-content-docs/current.json
文件:{ "sidebar.tutorialSidebar.category.Get Started": { "message": "快速开始", "description": "The label for category Get Started in sidebar tutorialSidebar" }, "sidebar.tutorialSidebar.category.Tutorials": { "message": "教程", "description": "The label for category Tutorials in sidebar tutorialSidebar" } }
-
结果:
- 英文站点显示:"Get Started" / "Tutorials"
- 中文站点显示:"快速开始" / "教程"
⚠️ 注意:不要创建独立的i18n/zh-Hans/.../sidebars.js
文件,应使用 JSON 翻译文件方式。这是 Docusaurus 官方推荐的标准做法。