Skip to main content
代表 CLI 的装饰图形。 代表 CLI 的装饰图形。

关于 CLI

使用 CLI 在本地预览文档、实时测试更改,并在部署到生产环境前运行质量检查。 CLI 在你的本地机器上运行,在需要实时数据时连接到你的 Mintlify 部署。

本地预览

运行 mint dev 在 localhost:3000 预览你的文档。在你编写和更新内容时,更改会实时显示,无需部署。登录后可在本地预览中启用搜索和 AI 助手。

运行质量检查

运行 mint broken-links 查找断链,mint a11y 检查无障碍性,mint validate 在发布到生产环境前验证文档构建。

检查代理就绪性

运行 mint score 评估代理在文档站点上的导航能力。不带参数时,该命令将对你配置的子域名进行评分。传入 URL 可评分任意其他站点。该命令显示总体就绪性评分和各项检查结果。

管理配置

运行 mint config 设置持久的默认值,如文档子域名。
使用 AI 编程工具在本地开发文档?安装 Mintlify skill 和 MCP 服务器,让你的编辑器具备编写符合 Mintlify 规范内容所需的上下文。

Install the Mintlify skill and MCP servers for AI coding tools.

在 Cursor 中打开

后续步骤