设置 GitHub 与 Guide 主题整合

What's my plan?

Suite

Growth, Professional, Enterprise, or Enterprise Plus

Support with

Guide all plans

快速查看：Guide 管理员 > 自定义设计图标 > 添加主题 > 从 GitHub 添加

GitHub 整合使您可以在 GitHub 中协作开发和维护主题，然后在 Guide 中预览或发布。要设置整合，请确保您的主题存储在 GitHub 中，然后在 Guide 中设置整合。

注意：GitHub 与帮助中心的整合不支持 GitHub Enterprise Server，但支持 GitHub Enterprise Cloud。如果您使用的是 GitHub Enterprise Server，您也可以使用 Guide 主题 API。

您必须是 Guide 管理员才能在 Guide 中设置 GitHub 整合。

本文章涵盖以下主题：

• 在 GitHub 中准备主题
• 设置整合

在 GitHub 中准备主题

在 Guide 中设置整合之前，您需要确保您的主题在 GitHub 中。如果您不熟悉 Git 和 GitHub，请查看此教程。如果您的主题已经在 GitHub 中，并且满足以下要求，请参阅在 Guide 中设置整合。

此整合对您的 GitHub 存储库有以下要求：

• 清单文件必须位于 GitHub 存储库的根目录下

  文件 manifest.json 应放置在 GitHub 存储库的根目录下，以便 Guide 添加您的主题。您也可以包含额外的文件，例如工具，这些文件在导入到 Guide 时会被忽略。

• GitHub 存储库只能有一个主题

  您在每个存储库中只能管理一个主题。您可以在主题导入期间使用分支选项，以尝试主题的各种变体。

将主题导入 GitHub 存储库

• 如果您当前没有主题，请复制Copenhagen 主题存储库中的主题并进行修改，以开始构建主题。这样，将来您就可以轻松将所做的改进从 Copenhagen 主题移植到您的主题。
• 如果您的主题在 Guide 中，请从 Guide 下载主题 ，然后创建 GitHub 存储库（如果您还没有），并将您的主题并入 GitHub 存储库。
• 如果您的主题不在 Guide 或 GitHub 中，请创建 GitHub 存储库（如果您还没有），并将您的主题并入 GitHub 存储库。

在 GitHub 中准备好主题之后即可在在 Guide 中设置整合。

设置整合

要设置 GitHub 整合，您需要确保您的主题存储在 GitHub 中，然后将您的主题从 GitHub 抓取到 Guide。这种一次性抓取可在您的主题和 GitHub 之间建立连接。

设置整合后，您将在 GitHub 中处理主题，然后待准备就绪后在 Guide 中更新主题。在 Guide 中，您可以预览或实时发布主题。

设置 GitHub 与 Guide 主题整合

1. 在 GitHub 中，确保您已准备好主题。
2. 在 Guide 中，单击侧栏中的自定义设计图标 ()。

   “主题”页面随即打开。

3. 单击右上角的添加主题。
4. 单击从 GitHub 添加。

   

5. 输入存储库的 URL，如果您要从默认分支以外的分支抓取，可以选择输入分支名称，然后单击导入。
6. 如果出现提示，请登录 GitHub，然后单击授权 Zendesk。

导入完成后，主题页面上将显示主题缩略图。如果您遇到问题，请参阅 GitHub 与 Guide 主题整合的故障排除。

在 Guide 中的主题和 GitHub 之间建立连接后，您将在 GitHub 中管理您的主题，并根据需要在 Guide 中更新主题。