---
title: GitHub 双向同步
slug: docs/cn/github
createdAt: 2024-05-10T09:19:50.331Z
---

## 概述

GitHub 的双向同步功能允许在 GitHub 仓库和 Archbee 之间进行双向同步。与传统的单向同步（仅将源的更改更新到目标，例如从 GitHub 到 Archbee）不同，双向同步可确保在 GitHub 和 Archbee 中所做的更改都会在两个平台上体现。

:::hint{type="warning"}
尽管这是一个双向同步系统，我们仍将 GitHub 视为最终可信来源。我们会打开一个 PR，而是否合并该请求则取决于您。请注意，如果您合并它，Archbee 中的文档将会更新。
:::

无论您是开发人员、项目经理还是协作者，此功能都可让您将 GitHub 仓库与 Archbee 无缝同步，从而确保您的工作流程一致性。

## 开始使用 🏁

要在您的 Archbee 账户上启用双向同步，请按照以下步骤操作：

1. [与 Github 集成](https://docs.archbee.com/github#jJpEV)
2. 设置完成后，您将被重定向到配置页面，您应该会看到`GitHub 已连接`的状态。

## 创建新空间并在 GitHub 中编写 ✍️

当您创建一个新的 Space 时，您可以从**在 GitHub 上写作**选项中选择一个仓库。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/E5XdR0KUblJnl0jmol1vU_create-modal-light.png "Write in GitHub")

选择您的 Git 仓库以及您想要导入的分支，然后点击**添加空间**按钮（位于弹窗底部）：

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/ifk6IRw68pu4R-iFapJLW_git-modal-light.png "选择 GitHub 仓库")

完成后，您应该会收到一条通知，提示您的 GitHub 内容已导入。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/XsmkYQWHLWVcMcpH_uZdD_updates-2-light.png "GitHub 导入成功")

### 在 GitHub 中编辑 👈

::::WorkflowBlock
:::WorkflowBlockItem
在 Archbee 编辑器中，点击**在 GitHub 上编辑**按钮，您将被重定向到您的 GitHub 账户。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/3X34eFqER-fDOZdiBcfr5_edit-github-light.png "Edit in GitHub 按钮")
:::

:::WorkflowBlockItem
进行您的编辑。
:::

:::WorkflowBlockItem
准备好后，点击**提交更改**按钮。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/zwgox6xjsw-Z4dLXCuNdC_git-light.png "Commit changes 按钮")
:::

:::WorkflowBlockItem
返回 Archbee。当您在右下角收到通知后，内容应会实时更新。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/6fwrfavG3o8L8w77BE0Ig_updates-light.png "内容更新通知")
:::
::::

### 创建 PR 👈

::::WorkflowBlock
:::WorkflowBlockItem
在 Archbee 编辑器中，点击** 编辑** 按钮，您的空间将启用审阅系统。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/ddKxEhoipsIKaRuFyR4P1_edit-archbee-light.png "Edit 按钮")
:::

:::WorkflowBlockItem
在 Draft 模式中编写/替换您的内容。
:::

:::WorkflowBlockItem
完成此操作后，前往右上角的 **发布空间**。选择 **推送到GitHub拉取请求**，然后点击 **审查并推送到 Gitbub 的PR** 进行审阅。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/0jmYkevXy1M7N0fs7ZrhR_publish-2-light.png "Review&Push to GitHub PR 按钮")
:::

:::WorkflowBlockItem
审阅您的更改，如果一切正常，点击 **推送到 GitHub PR**按钮。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/npQhrzzRke9pNHfnecada_review-light.png "Push to GitHub PR 按钮")
:::

:::WorkflowBlockItem
使用 **推送到 GitHub 拉取请求** 按钮在您的 GitHub 仓库中打开 pull request：

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/Akc8HBcbXcGegwCInbCzb_push-light.png "Push to GitHub PR 链接")
:::

:::WorkflowBlockItem
在 GitHub 仓库中审阅更改。
:::

:::WorkflowBlockItem
点击 **合并拉取请求** -> Confirm Merge。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/KcZcEczKWvQmFbvaer9d5_pull-2-git-light.png "Merge pull request 按钮")
:::

:::WorkflowBlockItem
返回 Archbee。一旦您收到成功通知，内容将更新到 GitHub：

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/6fwrfavG3o8L8w77BE0Ig_updates-light.png "内容更新成功通知")
:::
::::



## 选择 GitHub 分支 🕎

要启动同步流程，您需要选择 GitHub 仓库中 Archbee 将监控更改的特定分支。随后，您需要在此指定分支中打开 pull request 来触发同步机制。

如果未能自动运行，您可以通过导航至 **空间设置** > **GitHub 集成**> 点击 **与仓库同步** 按钮强制同步。

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/fI7AljLEoxH6XS-AQmjYL_settings-light.png "选择 GitHub 分支")