jekyll(ジキル)は、テンプレートを使って静的な Web サイトを構築するための Ruby プログラム。
通常はローカルに jekyll をインストールするが、GitHub Pages では必ずしも必要ないという話。
通常の手順
こちら に基本的な手順の説明。
ローカルな Ruby 環境に jekyll をインストール する
jekyll に必要な テンプレートファイル群 を構成し、_config.yml
や テンプレートファイル を設定する
YAML で記述した先頭ブロックの レイアウトとタイトル に続けて、 HTML、Markdown、textile のいずれかの記法を使って記事を書く
jekyll で HTML ページを生成し(jekyll --server --auto
)、ローカルで確認(http://0.0.0.0:4000/)、デプロイ(_site
に生成されたページ群を git 経由でリモートにコピー)する
GitHub Pages の場合
一方 GitHub では、GitHub Pages 上に jekyll に必要なファイル群があれば、自動的に HTML を生成してくれるので、必ずしもローカルに jekyll をインストールしなくても何とかなる。
もっともローカルで最終的なレンダリング結果を確認するためにも、jekyll をインストールするに越したことはないが…
1ページだけの GitHub Pages なら、最小構成ファイル群は以下の通り。
次は、テンプレートファイル default.html
の例。
index.md
には default.html
の content
の中身を記述する。
index.md
以外にも、index.html
や index.textile
でも OK だが、先頭の layout
、title
が重要。これがないとレンダリングしてくれない。
css/styles.css
で装飾し、必要なら images
や script
、favicon.ico
などもお好みで。
そしてこれらファイル群を プロジェクト・リポジトリの gh-pages
ブランチに push する。
さらに複雑なテンプレートの作り方

サイドバー付きページのテンプレートを、Initializr 2 をベースに構成する。

参考情報