GitHub PagesとJekyllについて
GitHub Pages は、GitHub Free のパブリックリポジトリ、GitHub Pro のパブリックおよびプライベートリポジトリ、GitHub Team、GitHub Enterprise Cloud、GitHub Enterprise Server で利用いただけます。
通常のHTMLコンテンツのサポートに加えて、GitHub Pagesは広く使われている静的サイトジェネレータであるJekyllをサポートしています。
GitHub PagesはJekyllと深く統合されています。Jekyllは広く使われている静的サイトジェネレータで、blogとソフトウェアドキュメンテーション用に設計されていますが、それ以上に広く使われています。 Jekyllを使えば、サイト全体にわたるヘッダやフッタを各ページにコピーせずに簡単に作成できるようになります。 また、高度なテンプレート機能とJekyll テーマのサポートも提供します。
GitHub Pagesは任意の静的サイトジェネレータと合わせて使えるように設計されていますが、Jekyllは多くのビルトインサポートがあり、GitHub Enterpriseが公式に詳細にドキュメント化している唯一の静的サイトジェネレータです。 GitHub Pagesを他の静的サイトジェネレータと使う方法に関する詳しい情報についてはJekyll以外の静的サイトジェネレータの利用を参照してください。
Jekyll の主な利点は以下のとおりです:
- HTML の代わりに Markdown を利用できます。 Markdownは読み書きがシンプルです。
- CSS ファイルをコピーすることなく Jekyll テーマをサイトに追加できます。
- ヘッダやフッタなど、ファイル間で共有される共通テンプレートを利用できます。
- GitHub Pages でサイトをビルドするための単純化されたビルドプロセスを利用できます。
Jekyllのビルドプロセス
JekyllのGitHub Pagesでの単純化されたビルドプロセスは、他の静的サイトジェネレータの代わりにJekyllを使うことの最も大きな利点の1つです。 GitHub Pagesは、サイトのビルドプロセスをサイトの公開ブランチへの単一のプッシュで管理します。 以下がサイトを管理するためのJekyllのビルドプロセスです。
- ファイルの変更をpagesの公開ブランチにプッシュする
- GitHub Pagesがサイトを公開する。
ノート： 使用する公開ブランチは、所有するGitHub Pagesサイトの種類によります。
- ユーザもしくは Organization の pages の場合、
masterブランチを使ってください。 - プロジェクト pages の場合、
gh-pagesもしくはmasterブランチを使ってください。 あるいは、サイトをmasterブランチの/docsフォルダから公開することもできます。 詳しい情報についてはGitHub Pagesのための公開ソースの設定を参照してください。
Jekyllのサイトの例
JekyllはGitHub Pages用に最も広く使われている静的サイトジェネレータです。 GitHub Pagesgemでの依存関係の管理、特定のビルド失敗のメッセージ、トラブルシューティングに関するさらに特定のヘルプを含む、Jekyllが提供するビルトインサポートを利用したいなら、Jekyllを使うことをおすすめします。
以下のGitHubショウケースには、Jekyllサイトの例が含まれています。