前置条件

  • Node.js 20 或更高版本。
  • npm 10 或更高版本。
  • 已登录 Cloudflare 账号,用于后续 Pages 发布。

安装依赖

npm install

本地预览

npm run dev
默认预览地址通常是 http://localhost:3000。如果端口被占用,可以使用:
npx mintlify dev --port 3001

日常编辑流程

  1. 在对应的 .mdx 页面中补充内容。
  2. 修改 docs.json 中的导航、品牌、SEO 或跳转规则。
  3. 本地预览并检查链接。
  4. 提交到仓库或执行 Pages 发布。