启用 GitLab 同步

设置并授权 GitBook 的 GitLab 集成

开始使用

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

A GitBook screenshot showing GitLab Sync configuration options
GitLab 同步配置选项。

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

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

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

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

  • api

  • read_repository

  • write_repository

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

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

选择仓库和分支

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

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

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

执行初始同步

首次同步时,您可以选择以下两个方向之一进行同步:

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

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

编写并提交

您可以开始使用了。您会注意到如果您的空间处于 实时编辑 模式下,实时编辑现在被锁定。这使得当团队中的某人合并一个时,GitBook 能够可靠地将内容同步到您的仓库。 变更请求 时可靠地将内容同步到您的仓库。

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

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

最后更新于

这有帮助吗?