Skip to main content

​
前提条件

  • 已全局安装 Mintlify CLI，或使用 npx mint 运行命令。
  • 包含有效 docs.json 文件的文档目录。

​
启动本地预览

导航到包含 docs.json 文件的文档目录，然后运行：
本地预览在 http://localhost:3000 启动。编辑时，更改会实时显示。 默认情况下，预览会自动在浏览器中打开。要阻止浏览器打开，请使用 --no-open 选项：
要在不全局安装 CLI 的情况下生成预览，请运行：

​
登录以启用搜索和助手

你需要使用 Mintlify 账户对 CLI 进行身份验证，才能启用搜索和 AI 助手。
使用 mint login 命令完成身份验证后，CLI 会将你的凭据存储在 ~/.config/mintlify/config.json 中，以便你在各会话之间保持登录状态。CLI 还会提示你选择一个默认项目，mint automations 等命令会使用该项目。 登录后，运行 mint dev 启动带有搜索和助手功能的本地预览。助手使用与已部署文档站点相同的索引内容。 要检查你的身份验证状态，请运行：
要注销，请运行：

​
自定义端口

默认情况下，CLI 使用端口 3000。要使用不同的端口，请使用 --port 选项：
如果端口已被占用，CLI 会自动尝试下一个可用端口。

​
跳过 OpenAPI 处理

如果你有大量 OpenAPI 文件，可以在本地开发时使用 --disable-openapi 选项跳过 OpenAPI 处理以提高性能：

​
禁用导航预加载

默认情况下，本地预览会预加载附近的页面，让页面之间的导航感觉是瞬时的。对于非常大的站点，这可能会拖慢你当前正在查看的页面，因为许多页面同时在后台编译。 如果你有数千个页面，并且注意到本地预览时页面加载缓慢，可以使用 --disable-prefetch 选项禁用预加载：
禁用预加载后，页面只会在你导航到它们时才会编译。单个页面加载时间会比预加载的页面更长，但你请求的页面不会与后台编译争抢资源。

​
以特定组预览

如果你使用基于组的访问控制，可以使用 --groups 选项以特定身份验证组进行预览：
有关组的更多信息，请参阅身份验证设置。