本地开发

前置条件：

按以下步骤在本机安装并运行 Mintlify。

安装 Mintlify CLI

npm i -g mint

本地预览

进入 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.

请注意：每个 CLI 版本都对应一个特定版本的 Mintlify。如果你的本地预览效果与生产环境不一致，请更新 CLI：

mint update

CLI 可以帮助校验文档中的链接。要查找断链（broken links），运行：

mint broken-links

如果部署成功，你会看到类似如下的提示：

建议在 IDE 中安装扩展以识别并格式化 MDX。如果你使用 VSCode，可以安装 MDX VSCode extension 获取语法高亮，并使用 Prettier 进行格式化。

Error: Could not load the "sharp" module using the darwin-arm64 runtime

这通常是由于 Node.js 版本过旧导致。可以尝试：

问题：遇到未知错误

解决方法：到用户目录删除 ~/.mintlify 文件夹，然后重新运行 mint dev。

想了解最新 CLI 版本有哪些变化？查看 CLI changelog。