GitHub 上に ページを作成する

GitHub には username.github.com というサブドメインでユーザページを作ることができます。最近知りました。GitHub Pages に説明が載っています。

私もさっそく作ってみました

ユーザページの作り方

username.github.com というリポジトリを作って、master ブランチに HTML ファイルをコミットするだけです。

$ mkdir username.github.com
$ cd username.github.com/
$ git init
$ touch index.html
$ git add .
$ git commit -m "first commit"
$ git remote add origin git@github.com:username/username.github.com.git
$ git push origin master

また、http://username.github.com/projectname という URL でプロジェクト (リポジトリ) 専用のページを作ることもできます。

プロジェクトページの作り方

リポジトリに gh-pages という名前のブランチを作るだけです。私は Git のブランチに詳しくないため、先の説明ページのコマンドを写経しました。既存のリポジトリディレクトリで作業を開始します。

$ cd /path/to/repository
$ git symbolic-ref HEAD refs/heads/gh-pages
$ rm .git/index
$ git clean -fdx
$ echo "My GitHub Page" > index.html
$ git add .
$ git commit -a -m "First pages commit"
$ git push origin gh-pages

試しに Processor.js のサンプルページを上げてみました

Git でブランチを切り替えるには git-checkout を使えばいいようなので、

$ git checkout origin/master

で、gh-pages ブランチから master ブランチに復帰できます。

master ブランチ内に gh-pages ブランチを submodule で追加する

ブランチの切り替えが面倒になったので、submodule を使って master ブランチから参照するようにしました。

$ cd /path/to/repository
$ git submodule add -b gh-pages git@github.com:username/project.git pages

他の PC で clone したら pages の中身が空になっていました。その場合は submodule の初期化が必要らしいです。

$ cd /path/to/repository
$ git submodule init
$ git submodule update