前提条件
- Node.js v20.17.0+（推荐 LTS 版本）
安装 CLI
创建新项目
| Flag | 描述 |
|---|---|
--name | 项目名称。如果未提供，CLI 会提示输入。 |
--theme | 项目主题。如果未提供，CLI 会提示选择。 |
--force | 无需确认即覆盖当前目录。 |
--name 和 --theme 选项。
更新
mint update，请使用最新版本重新安装 CLI：
格式化
- Cursor、Windsurf、VS Code：MDX VS Code 扩展 和 Prettier
- JetBrains：MDX IntelliJ IDEA 插件 和 Prettier
故障排除
Error: Could not load the "sharp" module using the darwin-arm64 runtime
Error: Could not load the "sharp" module using the darwin-arm64 runtime
这可能是由于 Node.js 版本过旧导致的。请尝试以下步骤：
- 卸载当前版本的 mint CLI：
npm uninstall -g mint - 升级到 Node.js v20.17.0+。
- 重新安装 mint CLI：
npm install -g mint
问题：遇到未知错误
问题：遇到未知错误
解决方案：前往设备根目录，删除
~/.mintlify 文件夹。然后重新运行 mint dev。Error: permission denied
Error: permission denied
这是因为你没有全局安装 Node 包所需的权限。解决方案：尝试运行
sudo npm i -g mint。当提示时，输入你用于解锁电脑的密码。本地预览与在线文档不一致
本地预览与在线文档不一致
这可能是由于 CLI 版本过旧导致的。解决方案：运行
mint update 获取最新更改。mintlify 与 mint 包
mintlify 与 mint 包
如果你遇到 CLI 包的问题，首先运行
npm ls -g 查看全局安装了哪些包。如果你不使用 npm，请尝试 which mint 来定位安装位置。如果你同时安装了 mint 和 mintlify 包，请卸载 mintlify：安装后客户端版本显示 'none'
安装后客户端版本显示 'none'
如果运行
mint version 后客户端版本显示为 none，可能是 CLI 因企业防火墙或 VPN 而无法下载客户端应用程序。解决方案：请你的 IT 管理员将 releases.mintlify.com 添加到网络允许列表中。