T.I.D.

Git や GitHub と戯れる、オレオレ的おとなの遊び場

jekyllで作る簡単GitHub Pages

jekyll(ジキル)は、テンプレートを使って静的な Web サイトを構築するための Ruby プログラム。

通常はローカルに jekyll をインストールするが、GitHub Pages では必ずしも必要ないという話。

通常の手順

こちら に基本的な手順の説明。

  1. ローカルな Ruby 環境に jekyll をインストール する

  2. jekyll に必要な テンプレートファイル群 を構成し、_config.ymlテンプレートファイル を設定する

  3. YAML で記述した先頭ブロックの レイアウトとタイトル に続けて、 HTML、Markdown、textile のいずれかの記法を使って記事を書く

  4. 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.htmlcontent の中身を記述する。

index.md 以外にも、index.htmlindex.textile でも OK だが、先頭の layouttitle が重要。これがないとレンダリングしてくれない。

css/styles.css で装飾し、必要なら imagesscriptfavicon.ico などもお好みで。 そしてこれらファイル群を プロジェクト・リポジトリの gh-pages ブランチに push する。

さらに複雑なテンプレートの作り方

"ページの構成"

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

"実際の GitHub Pages 適用例"

参考情報

Comments