Guideの各種テーマ機能の中で、最もパワフルなものは、テーマをインポート/ダウンロードする機能と、テーマをローカルで編集する機能です。テーマを大幅にアップデートしたり独自のテーマを作成したりする場合、これらのオプションにより、効率的な開発ワークフローが可能になります。
新しいテーマを構築したり、既存のテーマをローカルで編集するためのワークフローは以下のとおりです。
- Copenhagenテーマを追加するか、既存のテーマを複製することで、新しいテーマを開始します。
- オフラインで編集できるように、テーマをダウンロードします。
- 好みの開発ツールを使用して、ローカルでテーマを編集します。
- 編集したテーマを再びGuideにインポートします。
- 新しいテーマを公開します。
- その他の更新を行います。
新規テーマを開始する
新しいテーマをいちから構築する場合は、標準のCopenhagenテーマの新しいバージョンをスタート地点にすることを検討してください。それにはまず、新しいテーマを追加することで、Copenhagenテーマの新しいコピーをテーマページに追加します。また、GitHubのオープンソースCopenhagenリポジトリから新しいバージョンのテーマを入手することもできます。
多くのユーザーに人気があるのは、既存のテーマから開始し、大幅な変更を加えて、独自のテーマを作成する方法です。既存のテーマに改良を加えて、さらにスタイルの一部を保持したい場合は、テーマを複製します。
Copenhagenテーマの新しいコピーを追加するか、既存のテーマをコピーして新しいテーマを開始するには、「ヘルプセンターテーマのGuideへの追加」を参照してください。
テーマをダウンロードする
これでGuideからテーマをダウンロードする準備ができました。テーマは、テンプレート、JavaScript、CSS、およびアセットのzipアーカイブとしてダウンロードされます。これにより、独自の開発ツールを使用して、Guideの外でテーマを編集することができます。
テーマをダウンロードするには、「ヘルプセンターのテーマをダウンロードする」の手順に従います。
テーマをローカルで編集する
これで、独自の開発ツールを使用して、ローカルマシンでテーマの編集を開始する準備が整いました。
変更をプレビューするたびに、zipされたファイルがGuideにインポートされないようにするには、ローカルのWebブラウザで変更をプレビューします。テーマのローカルプレビューを設定するには、「テーマに加えた変更をローカルでプレビューする方法」を参照してください。
一度設定すれば、作業中のファイルを保存することで、変更をローカルでプレビューできます。テーマはブラウザで自動的に再読み込みされます。これにより、テンプレート、CSS、JavaScript、アセットに変更を加えてから、変更結果をプレビューするという反復的な作業ができるようになります。
さらに、ローカルマシンにテーマをダウンロードしたときは、お気に入りのバージョン管理リポジトリ(Git、Mercurial、SVNなど)にチェックインするとよいでしょう。
チームは、GitHubを使ってテーマを共同で開発およびメンテナンスし、GitHubからGuideにテーマをプレビューしたり公開したりすることができます。詳しくは「GitHubインテグレーションを使用したGuideテーマの設定」を参照してください。
テーマをインポートする
テーマをローカルに構築したら、テーマディレクトリをZIPアーカイブに圧縮し、テーマページでファイルをドラッグアンドドロップするか、インポートオプションを使用してGuideにインポートします。
この操作により、作成したテーマが新しいカスタムテーマとしてインポートされます。Guideでもプレビューすることができ、組織内の他のユーザーもテーマを表示することができます。
テーマをインポートするには、「ヘルプセンターのテーマをインポートする」を参照してください。
GitHubとのインテグレーションを設定した場合、GitHubからGuideのテーマを更新できます。別途ZIPアーカイブを作成してインポートする必要はありません。詳しくは「GuideにおけるGitHubの管理対象のテーマの更新方法」を参照してください。
もう1つの方法は、Themes APIで独自のインテグレーションを構築し、Guideにテーマをインポートして更新することです。Zendesk developer docsの「Theme Import Workflow」および「Theme Update Workflow」を参照してください。
新しいテーマを公開する
新しいテーマを公開する準備ができたら、ワークベンチのテーマメニューで「公開」をクリックします。
その他の更新を行う
gitやmercurialのようなバージョン管理システムを使用している場合は、Guideではなくローカルで変更を続けてください。変更を確認し、テーマを再度Guideにインポートします。Guideで誤ってテーマに変更を加えてしまった場合は、更新されたテーマをダウンロードし、ソース管理システムで変更を確認してください。