What's my plan?
Suite Growth, Professional, Enterprise, or Enterprise Plus
Support with Guide, any plan

Guide 模板化可呈现帮助中心主题包,其中包含可用于模板文件、CSS 和 JS 文件及 manifest 文件的 Curlybars 模板化语言。

Guide 模板化也称为模板化 API。

要了解更多关于帮助中心主题的信息,请参阅自定义帮助中心主题和模板化 API 文档。

本文章涵盖以下主题:
  • 关于 Guide 模板化版本
  • 查看模板化版本
  • 升级模板化版本

关于 Guide 模板化版本

下表列出了 Guide 模板化版本、发布日期,以及相关开发者文档页面的链接(您可以在其中找到每个版本中可用功能的特定信息)。

要查看所用版本,请参阅查看模板化版本。

表格 1.
版本 发布日期 开发者文档页面
1 2014 年 11 月 20 日 不适用
2 2020 年 2 月 24 日 升级模板化 API v1
3 2023 年 6 月 1 日 升级模板化 API v2
4 2024 年 7 月 2 日 升级模板化 API v3

查看模板化版本

您可以在编辑主题或查看 manifest 文件时看到模板化版本。

查看模板化版本

  1. 在知识管理中,单击侧栏中的自定义设计 ()。
  2. 单击要查看主题上的自定义。
  3. 单击编辑代码。
  4. 在主题名称下,您可以找到模板化版本号,例如版本化 API v2.

    此版本号对应于 manifest 文件中的 api_version 字段。

升级模板化版本

如果您已自定义帮助中心主题,可以升级到最新的模板化版本,以利用新功能、改进的性能和无障碍改进。

当您从主题体验迁移时,一些新的限制将应用到您的主题。在迁移过程中,我们取消了对某些文件类型和文件大小的限制,以便您将主题和资产移动到新的主题体验中,从而更易于使用。

例如,如果您有多个 PDF 或其他文件不再受主题资产支持,您就可以迁移主题。您可以从那里导出该主题,以便轻松检索所有这些文件。但是,您需要先移除主题中不受支持的文件,才能复制或重新导入该主题。

升级模板化版本

  1. 下载帮助中心主题(请参阅下载帮助中心主题)。
  2. 在本地打开主题包并编辑 manifest.json 文件。
  3. 在 manifest.json 文件中,找到 api_version 字段,并将其值更改为要升级到的版本。
  4. 在本地预览主题更改。预览主题时,如果您使用的是要升级到的版本中已弃用的助手,您将收到警告。
  5. 如果您使用的是已弃用的助手,请参阅相关开发者文档(请参阅关于 Guide 模板化版本),将助手替换为受支持的同等功能。

    再次预览主题,以确认没有进一步警告。

  6. 将已更新的主题上传到 Guide(请参阅导入帮助中心主题)。

    您可以查看模板化版本来检查新版本是否已应用。

由 Zendesk 提供技术支持