启用 GitLab 同步

为 GitBook 设置并授权 GitLab 集成

快速开始

在您希望与 GitLab 仓库同步的空间中，前往右上角的空间菜单，然后选择 与 Git 同步从提供者列表中，选择 GitLab Sync，并点击 配置.

GitLab 同步配置选项。

生成并输入您的 API 访问令牌

您可以在 GitLab 的用户设置中生成 API 访问令牌。

在 GitLab 中有两种类型的访问令牌：项目令牌和个人令牌。请注意，为了使集成工作，您需要使用个人令牌，可从 GitLab 的用户偏好菜单生成。

确保为您的令牌启用以下访问权限：

• api

• read_repository

• write_repository

如果您创建的令牌还附带了特定角色，也请确保它具有 维护者 或 管理员 角色。

然后在配置 GitLab 集成时，您可以将该令牌粘贴到 API 访问令牌字段中。

选择仓库和分支

选择您想与 GitBook 内容保持同步的仓库。

看不到您的仓库？ 在创建 API 令牌时，确保已设置正确的权限。

选择正确的仓库后，选择要将提交推送到并从中同步的分支。

对于许多 GitLab 仓库， main（主分支） 分支可能会被自动设置为受保护。如果是这种情况，我们建议添加一个特定分支来同步您的内容。然后您可以将其合并到 main（主分支） 并保持保护设置不变。

执行初始同步

首次同步时，您可以选择以下两种方向之一进行同步：

1. GitBook -> GitLab 将同步您空间的内容 到 所选分支。如果您从一个空仓库开始并希望快速将 GitBook 内容导入，这是很好的选择。

2. GitLab -> GitBook 将同步您空间的内容 从 所选分支。如果您的仓库中已有现有的 Markdown 内容并希望将其导入到 GitBook，这非常有用。

编写并提交

您可以开始了。您会注意到如果您的空间处于 实时编辑 模式下，实时编辑现在被锁定。这允许 GitBook 在团队成员合并一个 变更请求 到 GitBook 时可靠地将内容同步到您的仓库。

当您在 GitBook 上编辑时，每次更改请求的合并都会导致对您所选的 GitLab 分支进行一次提交。

当您向 GitLab 提交时，每次提交都会作为历史提交同步到您的 GitBook 空间。