Skip to main content
先决条件:
  • Node.js 版本 19 或更高
  • 一个包含docs.json文件的文档仓库
按照以下步骤在您的操作系统上安装和运行Mintlify。
1

安装 Mintlify 命令行界面

npm i -g mint
2

本地预览

导航到您的文档目录，其中包含您的 docs.json 文件，然后运行以下命令：
mint dev
您的文档本地预览将在 http://localhost:3000 可用。

​
自定义端口

默认情况下，Mintlify 使用端口 3000。您可以通过使用 --port 标志来自定义 Mintlify 运行的端口。例如，要在端口 3333 上运行 Mintlify，请使用此命令： 
mint dev --port 3333
如果您尝试在已使用的端口上运行Mintlify，它将使用下一个可用的端口： 
Port 3000 is already in use. Trying 3001 instead.

​
Mintlify版本

请注意，每个CLI版本都与Mintlify的一个特定版本相关联。如果您的本地预览与生产版本不一致，请更新CLI： 
npm mint update

​
验证链接

CLI可以帮助您验证文档中的链接。要识别任何断链，请使用以下命令： 
mint broken-links

​
部署

如果部署成功，你应该看到以下内容：
Screenshot of a deployment confirmation message that says All checks have passed.

​
代码格式化

我们建议在您的IDE上使用扩展来识别和格式化MDX。如果您是VSCode用户，请考虑使用MDX VSCode扩展进行语法高亮，以及Prettier进行代码格式化。

​
故障排除

这可能是由于node版本过时所致。请尝试以下操作：
  1. 移除当前已安装的 CLI 版本：npm remove -g mint
  2. 升级到 Node v19 或更高版本。
  3. 重新安装 CLI：npm i -g mint
解决方案：前往您的设备根目录，删除~/.mintlify文件夹。然后再次运行mint dev。
好奇最新的CLI版本有什么变化吗？查看[CLI变更日志](https://www.npmjs.com/package/mintlify?activeTab=版本）。