安装 CLI
安装 Mintlify CLI 以在本地预览文档、实时测试更改，并在部署到生产环境前捕获构建错误。
- Node.js v20.17.0+（推荐 LTS 版本）
npm i -g mint在使用 AI 编码工具？复制下面的 prompt，让你的代理安装 CLI 并验证其是否正常工作。
全局安装 Mintlify CLI 并验证安装。
要从 Mintlify 入门模板创建新的文档项目，请运行以下命令：
mint new [directory]搭建一个新的 Mintlify 项目。
如果你没有指定目录，CLI 会提示你创建新的子目录或覆盖当前目录。
覆盖当前目录会删除所有现有文件。
| Flag | 描述 |
|---|---|
--name | 项目名称。如果未提供，CLI 会提示输入。 |
--theme | 项目主题。如果未提供，CLI 会提示选择。 |
--template | 预定义模板。如果未提供，CLI 会提示选择。 |
--force | 无需确认即覆盖当前目录。 |
在交互模式下，CLI 会询问你是选择主题还是克隆模板。要跳过提示，直接传递 --template 选项：
mint new my-docs --template <template-name>你可以将 --template 与 --theme 组合使用，以覆盖模板的默认主题：
mint new my-docs --template <template-name> --theme <theme>在 GitHub 上的 mintlify/templates 仓库中查看可用模板。在交互模式下，CLI 会自动获取并显示可用模板。
在非交互式环境（如 CI/CD 流水线或 AI 编码代理）中，你必须提供 --name 和 --theme 选项，或者提供 --template 选项。
如果你的本地预览与已部署的文档不同步，请将 CLI 更新到最新版本：
mint update如果你的版本中没有 mint update，请使用最新版本重新安装 CLI：
npm i -g mint@latest对于 MDX 文件中的语法高亮和代码格式化，我们推荐使用以下扩展：
- Cursor、Devin Desktop、VS Code：MDX VS Code 扩展 和 Prettier
- JetBrains：MDX IntelliJ IDEA 插件 和 Prettier