Docs

🚀 Mintlify 启动套件

使用此启动套件，你可以快速部署文档并进行个性化定制。该套件能帮助你轻松开启文档项目，解决文档部署和定制的难题，为你节省时间和精力。

🚀 快速开始

点击此仓库顶部绿色的 使用此模板 按钮，即可复制 Mintlify 启动套件。该启动套件包含以下示例：

• 指南页面
• 导航功能
• 定制选项
• API 参考页面
• 常用组件的使用

遵循完整的快速入门指南

📦 安装指南

安装 Mintlify CLI 以在本地预览文档更改。使用以下命令进行安装：

npm i -g mint

在文档根目录（即 docs.json 所在的目录）运行以下命令：

mint dev

在 http://localhost:3000 查看本地预览。

📚 详细文档

发布更改

从 仪表盘 安装我们的 GitHub 应用程序，以便将仓库中的更改同步到部署环境。推送到默认分支后，更改将自动部署到生产环境。

需要帮助？

故障排除

• 若开发环境无法运行：运行 mint update 以确保你使用的是最新版本的 CLI。
• 若页面显示 404：确保你在包含有效 docs.json 的文件夹中运行。

资源

• Mintlify 文档
• Mintlify 社区