テーマをローカルで編集する方法

Suite Growth、Professional、Enterprise、Enterprise Plus Professional、Enterpriseプラン

Guideの各種テーマ機能の中で、最も強力なものは、テーマのインポートとダウンロード、およびテーマをローカルで編集する機能です。テーマを大幅に変更したり独自のテーマを作成したりする場合、これらのオプションにより、効率的な開発ワークフローを可能にします。

新しいテーマを構築したり、既存のテーマをローカルで編集するためのワークフローは、次のようになります。

Copenhagenテーマを追加するか、既存のテーマを複製することで、新しいテーマを開始する
テーマをダウンロードして、オフラインで作業する
好みの開発ツールを使用して、ローカルでテーマを編集する
編集したテーマを再びGuideにインポートする
新しいテーマを公開する
追加でアップデートする

新しいテーマを開始する

新しいテーマをいちから構築する場合は、標準のCopenhagenテーマの新しいバージョンをスタート地点にすることを検討してください。それにはまず、新しいテーマを追加することで、Copenhagenテーマの新しいコピーをテーマページに追加します。また、オープンソースのGitHubのCopenhagenリポジトリからテーマの最新バージョンを入手することもできます。

多くのユーザーに人気があるのは、既存のテーマから開始し、大幅な変更を加えて、独自のテーマを作成する方法です。既存のテーマを刷新していて、既存のスタイルをいくつか残したい場合は、テーマを複製することができます。

Copenhagenの最新のコピーを追加するか、既存のテーマをコピーして新しいテーマを開始するには、「Guideへのヘルプセンターテーマの追加」を参照してください。

テーマをダウンロードする

これで、Guideでテーマをダウンロードする準備が整いました。テーマは、テンプレート、JavaScript、CSS、アセットのZipアーカイブとしてダウンロードされます。これにより、独自の開発ツールを使用して、Guideの外でテーマを編集することができます。

テーマをダウンロードするには、「ヘルプセンターのテーマをダウンロードする」を参照してください。

テーマをローカルで編集する

これで、独自の開発ツールを使用して、ローカルマシンでテーマの編集を開始する準備が整いました。

変更をプレビューするたびに、ファイルがzipされインポートされないようにするには、Zendesk Apps Tool（ZAT）を使用して、変更をWebブラウザでローカルにプレビューします。ローカルプレビューの目的は、テーマの開発者が慣れ親しんだツールを使用してテーマを素早く簡単に作成できるようにすることです。ZATテーマのプレビューを設定するには、「テーマに加えた変更をローカルでプレビューする方法」を参照してください。

プレビューモードを開始したら、お気に入りのテキストエディタでテーマファイルを修正することができます。ローカルプレビューにはライブ再ロード機能があり、ファイルを変更すると自動的にプレビューが更新されます。ここから、テンプレート、CSS、JavaScript、およびアセットをすばやく変更できます。

さらに、ローカルマシンにテーマをダウンロードしたときは、お気に入りのバージョン管理リポジトリ（Git、Mercurial、SVNなど）にチェックインするとよいでしょう。

また、チームはGitHubを使ってテーマを共同で開発および管理でき、GitHubからGuideでプレビューしたり、公開したりすることもできます。「GitHubインテグレーションを使用したGuideテーマの設定」を参照してください。

テーマをインポートする

テーマをローカルに構築したら、テーマディレクトリをZIPアーカイブに圧縮し、テーマページでファイルをドラッグアンドドロップするか、インポートオプションを使用してGuideにインポートします。

この操作により、作成したテーマが新しいカスタムテーマとしてインポートされます。Guideでもプレビューすることができ、組織内の他のユーザーもテーマを表示することができます。

テーマをインポートするには、「ヘルプセンターのテーマをインポートする」を参照してください。

GitHubとのインテグレーションを設定している場合は、GitHubでGuideのテーマを更新することができます。別途ZIPアーカイブを作成してインポートする必要はありません。「GuideにおけるGitHubの管理対象のテーマの更新方法」を参照してください。

もう1つのオプションは、テーマAPIとの独自のインテグレーションを構築して、Guideでテーマのインポートや更新を行うことです。Zendeskの開発者向けドキュメントの「テーマのインポートワークフロー」と「テーマの更新ワークフロー」を参照してください。

新しいテーマを公開する

新しいテーマを公開する準備ができたら、ワークベンチのテーマメニューで「公開」をクリックします。

追加でアップデートする

gitやmercurialのようなバージョン管理システムを使用する場合は、Guideではなく、引き続きローカルで変更を行ってください。変更内容を確認し、テーマを再度Guideにインポートします。Guideでテーマを誤って変更してしまった場合は、更新されたテーマをダウンロードし、ソース管理システムでテーマの変更内容を確認してください。

重要：GitHubとのインテグレーションを設定している場合、Guideでテーマを変更するとGitHubのインテグレーションが解除されます。