核心框架
| 技术 | 版本 | 用途 |
|---|
| Docusaurus | ^3.9.2 | 文档框架、构建、路由 |
| React / React DOM | ^19.0.0 | 主题与自定义页面 |
| TypeScript | ~5.6.2 | 配置与组件类型 |
| @docusaurus/theme-mermaid | ^3.9.2 | Markdown 内 Mermaid 渲染 |
| Wrangler | ^4.68.0 | Cloudflare Workers 部署 |
项目配置要点
| 文件 | 职责 |
|---|
docusaurus.config.ts | 站点标题、i18n、预设、navbar、footer、Mermaid |
sidebars.ts | 文档侧边栏结构 |
wrangler.jsonc | Workers 名称、静态资源目录 build/ |
versions.json | 文档版本列表 |
package.json | 脚本与依赖 |
npm 脚本
| 命令 | 作用 |
|---|
npm start | 开发服务器（热更新） |
npm run build | 生产构建，输出至 build/ |
npm run serve | 本地预览构建产物 |
npm run preview | build + wrangler dev 本地预览 Workers 部署形态 |
npm run deploy | build + wrangler deploy 发布至 Cloudflare |
npm run typecheck | TypeScript 类型检查 |
上游与参考
本文档描述部内文档站的目录、写作与部署方式；下列开源项目的 API、配置与版本说明以官方为准。
浏览器与环境
- Node.js：>= 20.0（见
package.json engines）
- 浏览器：production 目标
>0.5%, not dead