开发

按照以下步骤在您的操作系统上安装和运行 Mintlify:

第 1 步: 安装 Mintlify:

npm i -g mintlify

第 2 步: 导航到文档目录（docs.json 文件所在的位置）并执行以下命令:

mintlify dev

您的文档的本地预览将在 http://localhost:3000 上可用。

​

自定义端口

默认情况下, Mintlify 使用 3000 端口。您可以使用 --port 标志来自定义 Mintlify 运行的端口。例如, 要在端口 3333 上运行 Mintlify, 请使用以下命令:

mintlify dev --port 3333

如果您尝试在已被占用的端口上运行 Mintlify, 它将使用下一个可用端口:

端口 3000 已被占用。尝试使用 3001 端口。

​

Mintlify 版本

请注意, 每个 CLI 发布版本都与特定版本的 Mintlify 相关联。如果您的本地网站与生产版本不一致, 请更新 CLI:

npm i -g mintlify@latest

​

验证链接

CLI 可以帮助验证文档中的引用链接。要识别任何损坏的链接, 请使用以下命令:

mintlify broken-links

​

部署

如果部署成功, 您应该看到以下内容:

​

代码格式化

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

​

故障排除

想了解 CLI 版本的变更内容？查看 CLI 更新日志。