Skip to main content
前提条件：
  • Node.js 版本 19 或更高
  • 包含 docs.json 文件的文档仓库
按照以下步骤在你的操作系统上安装并运行 Mintlify。
1

安装 Mintlify CLI

npm i -g mint
2

本地预览

进入包含 docs.json 的文档目录，运行以下命令：
mint dev
本地文档预览可通过 http://localhost:3000 访问。

​
自定义端口

默认情况下，Mintlify 使用 3000 端口。你可以通过 --port 标志自定义运行端口。例如在 3333 端口运行： 
mint dev --port 3333
如果你尝试使用的端口已被占用，Mintlify 会自动使用下一个可用端口： 
Port 3000 is already in use. Trying 3001 instead.

​
Mintlify 版本

每个 CLI 版本都对应一个 Mintlify 版本。如果本地预览与线上版本不一致，请更新 CLI： 
npm mint update

​
链接校验

CLI 可以帮助校验文档中的链接。要识别断链，请使用以下命令： 
mint broken-links

​
部署

部署成功后，你应当能看到如下提示：
部署确认消息的截图，显示 All checks have passed。

​
代码格式化

建议在 IDE 中安装扩展以识别并格式化 MDX。若你使用 VSCode，可考虑用于语法高亮的 MDX VSCode 扩展 与用于代码格式化的 Prettier。

​
故障排查

可能由于 Node 版本过旧。请尝试：
  1. 移除当前安装的 CLI：npm remove -g mint
  2. 升级到 Node v19 或更高。
  3. 重新安装 CLI：npm i -g mint
解决方案：到设备根目录删除 ~/.mintlify 文件夹，然后重新运行 mint dev。
想了解最新 CLI 版本的变更？请查看 CLI 更新日志。