GitHub

将文档与 GitHub 存储库同步

Mintlify 通过 GitHub 应用自动将你的文档与 GitHub 存储库同步。

​

安装 GitHub 应用

在拥有你文档存储库的 GitHub 账户或组织中安装 Mintlify GitHub 应用。你必须在该存储库中拥有组织所有者或管理员权限才能安装应用。如果权限不足，需要由存储库所有者批准安装请求。

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

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

​

权限

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

读取权限：

• metadata: 基本存储库信息

读写权限：

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

该应用仅会访问你明确授予其访问权限的存储库。若启用了 branch 保护规则，应用无法直接推送到受保护的 branch。

​

管理存储库访问

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

​

配置文档来源

在控制台的 Git Settings 部分，您可以更改用于构建文档的组织、存储库或 branch。

​

故障排查

​

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. Navigate to Git Settings

   前往控制台中的 Git Settings。

2. Revalidate your settings

   点击 Git 设置卡片右上角的绿色勾选图标以重新验证存储库设置。此操作会强制更新设置，以准确反映你的存储库是公开还是私有。