はじめに
Octopress + GitHub Pages の記事はたくさんあるのですが、User/Organization 用の Page である "USERNAME.github.io" ドメインの例しか見つかりませんでした。
ドキュメントを読んでやってみたところ、ふつうのプロジェクトリポジトリの gh-pages ブランチでもできたので、とりまとめて書いておきます。
Octopress のインストール
Octopress Setup に従って初期セットアップを行います。
ここでは bundler1 はインストール済みとします。
git clone git://github.com/imathis/octopress.git octopress-test
cd octopress-test
bundle install
rake install
この後、下記コマンドによって、ローカルマシン上でサイト表示を確認できるアプリケーションが起動します。
rake preview
http://localhost:4000 でサイト表示を確認できます。
GitHub Pages へのデプロイ設定
User/Organization Page にデプロイする場合
はじめに GitHub で USERNAME.github.io というリポジトリを作成して下さい。
ここで USERNAME には自分の GitHub アカウント名を入れて下さい。
rake setup_github_pages を実行するとリポジトリURLの入力を求められます。
% rake setup_github_pages
Repository url: git@github.com:USERNAME/USERNAME.github.io.git
これによって、以下のことが行われます。
-
git@github.com:USERNAME/USERNAME.github.io.gitが origin remote として追加される -
_deploy/ディレクトリがリポジトリの master ブランチに設定される - 親ディレクトリは source というブランチになる
デプロイ時には、下記コマンドを実行します。
rake generate
rake deploy
これによって、_deploy/ 以下にサイトのコンテンツ一式がビルドされ、その内容が GitHub に push されます。
http://USERNAME.github.io/ にアクセスすると、ローカルで preview した画面と同じ内容が表示されるでしょう。
最後に、ソースコードを管理するために、source ブランチも push しておきましょう。
git add .
git commit -m 'your message'
git push origin source
Project Page (gh-pages) にデプロイする場合
GitHub で任意の名前のリポジトリを用意します。
ここでは "USERNAME/octopress-test" というリポジトリだとします。
rake setup_github_pages を実行して、用意したリポジトリのURLを入力しましょう。
% rake setup_github_pages
Repository url: git@github.com:USERNAME/octopress-test.git
"USERNAME.github.io" リポジトリのときとは異なり、_deploy/ ディレクトリは gh-pages ブランチに設定されます。
デプロイコマンドは前項と同様です。
rake generate
rake deploy
http://USERNAME.github.io/octopress-test/ でサイトが表示されます。
ソースコードを管理するためには、remote のリポジトリURLを設定する必要があります。
git remote add origin git@github.com:USERNAME/octopress-test.git
git config branch.master.remote origin
この後の git add 〜 git push までの流れは同様です。
まとめ
Octopress を使うと簡単に GitHub Pages で静的サイトを構築できますね。