GitHub

将文档与 GitHub 仓库同步

Mintlify 通过 GitHub 应用自动将你的文档与 GitHub 仓库保持同步。

​

安装 GitHub 应用

在拥有文档仓库的 GitHub 帐号或组织上安装 Mintlify GitHub 应用。你必须在组织中拥有者身份，或在仓库中具备管理员权限才能安装该应用。如果缺少所需权限，则需要由仓库所有者批准安装请求。

通过你的控制台安装 Mintlify GitHub 应用。

我们建议仅授予托管文档的那个仓库的访问权限。

​

权限

安装 GitHub 应用时，你会被提示授予以下权限：

读取权限：

• metadata: 基本仓库信息

读写权限：

• checks: 在拉取请求上创建状态检查
• code: 在你向文档分支提交时读取文件变更
• deployments: 为拉取请求生成预览部署
• pull requests: 通过网页编辑器创建分支和拉取请求
• workflows: 管理用于文档部署的 GitHub Actions

该应用只会访问你明确授予访问权限的仓库。如果你启用了分支保护规则，该应用无法直接推送到受保护的分支。

​

管理仓库访问

安装我们的 GitHub 应用时，你可以授予对所有仓库或指定仓库的访问权限。我们建议仅授予存放文档的仓库访问权限。你可以随时在 GitHub 应用设置 中修改此选择。

​

配置文档来源

在仪表板的 Git 设置 中更改用于构建文档的组织、仓库或分支。

​

疑难解答

​

GitHub 应用连接问题

如果你遇到 GitHub 应用相关问题，重置连接通常能解决大多数情况。

1. 通过 GitHub 卸载 Mintlify 应用

   1. 在 GitHub 中，前往 installations，在 Mintlify 应用旁点击 Configure。向下滚动并选择 Uninstall。
   2. 前往 Authorized GitHub Apps，在 Mintlify 应用旁选择 Revoke。
2. 重新安装 Mintlify 应用

   1. 在 Mintlify 控制台，前往 Git Settings 并安装 GitHub 应用。
   2. 在控制台的 My Profile 中为你的账户授权。

​

反馈插件不可用

如果你无法在仪表盘中启用“编辑建议”或“提交问题”选项，且你的仓库为公开仓库，请重新验证 Git 设置。

1. 前往 Git 设置

   在仪表盘中打开 Git Settings。

2. 重新验证设置

   点击 Git 设置卡片角落的绿色对勾，重新验证仓库设置。此操作会强制更新仓库的公开/私有状态。