Guide 模板化可呈现帮助中心主题包,其中包含可用于模板文件、CSS 和 JS 文件及 manifest 文件的 Curlybars 模板化语言。
Guide 模板化也称为模板化 API。
要了解更多关于 Guide 主题的信息,请参阅自定义帮助中心主题和帮助中心模板开发者文档。
本文涵盖以下主题:
关于 Guide 模板化版本
下表列出了 Guide 模板化版本、发布日期,以及相关开发者文档页面的链接(您可以在其中找到每个版本中可用功能的特定信息)。
要查看所用版本,请参阅查看模板化版本。
版本 | 发布日期 | 开发者文档页面 |
---|---|---|
1 | 2014 年 11 月 20 日 | 不适用 |
2 | 2020 年 2 月 24 日 | 升级模板化 API v1 |
3 | 2023 年 6 月 1 日 | 升级模板化 API v2 |
4 | 2024 年 7 月 2 日 | 升级模板化 API v3 |
查看模板化版本
您可以在主题的编辑代码视图或 manifest 文件中查看模板化版本。
查看模板化版本
- 在 Guide 中,单击侧栏中的自定义设计图标 ()。
- 单击要查看主题上的自定义。
- 单击编辑代码。
- 在主题名称下,您可以找到模板化版本号,例如版本化 API v2.
此版本号对应于 manifest 文件中的
api_version
字段。
升级 Guide 模板化版本
如果您已自定义 Guide 主题,可以升级到最新的模板化版本,以利用新功能、改进的性能和无障碍改进。
升级模板化版本
- 下载帮助中心主题(请参阅下载帮助中心主题)。
- 在本地打开主题包并编辑 manifest.json 文件。
- 在 manifest.json 文件中,找到
api_version
字段,并将其值更改为要升级到的版本。 - 在本地预览主题更改。预览主题时,如果您使用的是要升级到的版本中已弃用的助手,您将收到警告。
- 如果您使用的是已弃用的助手,请参阅相关开发者文档(请参阅关于 Guide 模板化版本),将助手替换为受支持的同等功能。
再次预览主题,以确认没有进一步警告。
- 将已更新的主题上传到 Guide(请参阅导入帮助中心主题)。
您可以查看模板化版本来检查新版本是否已应用。