跳到主要内容
版本：Current

快速开始

适用对象​

  • 需要本地预览文档的成员
  • 准备提交文档改动的维护者

推荐预览方式​

技术部维护文档时，推荐每次修改后完整构建再预览，与生产环境行为一致：

npm run build
npm run serve

浏览器访问 http://localhost:3000（默认端口，以终端输出为准）。

或一条命令：

npm run preview

preview 会先构建，再通过 Wrangler 本地模拟 Cloudflare Workers 静态资源服务。

开发模式（可选）​

需要快速调试主题或 React 组件时：

npm start
  • 大部分 Markdown 修改会热更新
  • 某些配置变更（docusaurus.config.ts、sidebars.ts）需重启 dev server
  • 最终提交前仍建议执行 npm run build 确认无构建错误

第一次改文档​

  1. 在 docs/ 下找到或新建对应 .md 文件
  2. 如需出现在侧边栏，编辑 sidebars.ts（见 侧边栏与导航）
  3. 执行 npm run build && npm run serve 检查渲染效果
  4. 提交 PR

详细写作规范见 撰写新文档。