Guideテンプレートのバージョンについて

Suite Growth以上のプランで利用可能すべてのGuideプランで利用可能

Guideテンプレートは、ヘルプセンターのテーマパッケージをレンダリングします。テンプレートファイル、CSSファイル、JSファイル、マニフェストファイルで使用されるCurlybarsテンプレート言語が含まれています。

Guideテンプレートは、テンプレートAPIとも呼ばれます。

Guideテーマの詳細については、「ヘルプセンターテーマのカスタマイズ」および開発者向けドキュメントの「Help center Templates」を参照してください。

この記事では、次のトピックについて説明します。

次の表に、Guideテンプレートのバージョン、リリース日、および関連する開発者向けドキュメントページへのリンクを示します。このドキュメントページでは、各バージョンで利用可能な機能に関する具体的な情報を確認できます。

使用しているバージョンを確認するには、「テンプレートのバージョンを調べる」を参照してください。

テンプレートのバージョンを確認する

テンプレートのバージョンは、テーマのコードを編集ビューまたはマニフェストファイルから確認することができます。

テンプレートのバージョンを確認するには

Guideで、サイドバーにあるデザインをカスタマイズアイコン（）をクリックします。
表示したいテーマの「カスタマイズ」をクリックします。
「コードを編集」をクリックします。
テーマ名の下に、「テンプレートAPI v2」などのように、テンプレートのバージョン番号が表示されます。

このバージョン番号は、マニフェストファイルのapi_versionフィールドに対応します。

Guideテーマをカスタマイズしている場合、最新のテンプレートバージョンにアップグレードすることで、新機能、パフォーマンスの向上、アクセシビリティの改善などを利用することができます。

テンプレートのバージョンをアップグレードするには

「ヘルプセンターのテーマをダウンロードする」の手順に従って、ヘルプセンターのテーマをダウンロードします。
ローカルでテーマパッケージを開き、manifest.jsonファイルを編集します。
manifest.jsonファイルで、api_versionフィールドを見つけ、値をアップグレードしたいバージョンに変更します。
テーマに加えた変更をローカルでプレビューします。テーマをプレビューするときに、アップグレード先のバージョンで非推奨となったヘルパーを使用している場合は、警告が表示されます。
非推奨のヘルパーを使用している場合は、関連する開発者向けドキュメント（「Guideテンプレートのバージョンについて」）を参照して、ヘルパーをサポートされている同等のヘルパーに置き換えてください。
テーマをもう一度プレビューして、これ以上警告が出ないことを確認します。
更新されたテーマをGuideにアップロードします（「テーマやマニフェストファイルをインポートおよびダウンロードする方法」を参照）。
新しいバージョンが適用されたことは、「テンプレートのバージョンを確認する」で説明されている手順で確認できます。