设置 GitHub 与帮助中心主题整合

What's my plan?

Suite

Growth, Professional, Enterprise, or Enterprise Plus

Support with

Guide Professional or Enterprise

已验证人工智能概要 ◀▼

将您的帮助中心主题与 GitHub 整合，以便协作进行主题开发，并集中进行管理。在 GitHub 中准备您的主题，确保其满足要求，例如在根目录下有一个 manifest 文件。通过从 GitHub 导入主题，在“知识管理”中设置整合。在 GitHub 中管理更新，并在准备就绪时发布。

位置： 知识管理 > 自定义设计 () > 添加主题 > 从 GitHub 添加

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

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

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

本文章涵盖以下主题：

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

在 GitHub 中准备主题

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

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

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

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

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

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

将主题导入 GitHub 存储库

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

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

设置整合

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

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

设置 GitHub 与帮助中心主题整合

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

   “主题”页面随即打开。

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

   

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

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

建立连接后，您将在 GitHub 中管理主题，并根据需要在“知识管理”中更新主题。