S-JIS[2013-01-16/2013-02-01] 変更履歴

GutHub Pagesの使い方

GitHubのサービスのひとつであるGitHub Pagesのメモ。

概要

GitHub Pagesは、GitHubのサービスのひとつ。

GitHubにファイルをアップロードするとGitHubのサイトからファイルの内容を見られるが、ファイルそのものが直接見られる訳ではないので、例えばhtmlファイルを置いたとしてもウェブページとして表示されたりはしない。
GitHub Pagesを使うと、置いたファイルがそのまま使われるので、ウェブサイトを構築することが出来る。

GitHub Pagesを使うには、通常のリポジトリー内に「gh-pages」というブランチを作る。
このブランチ内に置かれたファイルがウェブサイト内のファイルとして使われる。

例

sandboxプロジェクト内にGitHub Pagesを作ってみる。

※メールアドレスの認証（verify）を事前に済ませておく必要がある！

1. ローカルのsandboxリポジトリー（自分のマシン内のリポジトリー）で「gh-pages」ブランチを作成する。

   $ cd sandbox
   $ git branch gh-pages	←gh-pagesブランチを作成
   $ git checkout gh-pages	←gh-pagesブランチに移動

2. 適当なファイルを作成し、コミットする。

   $ vi index.html
   $ git add .
   $ git commit

3. GitHubへアップロード（push）する。

   $ git push -u origin gh-pages	←初回のみ
   $ git push                   	←2回目以降

これで準備OK。

「http://ユーザー名.github.com/プロジェクト名」でウェブサイトにアクセスできる。
今回の例だと、ユーザー=hishidama・プロジェクト名=sandboxなので、「http://hishidama.github.com/sandbox/index.html」で、作成したindex.htmlがウェブページとして表示される。

※初回だと、pushしてから反映される（実際にアクセスできるようになる）まで10分くらいの時間がかかる。
※GitHubに登録したメールアドレスの認証（verify）をしていないと、アクセスできない。（404エラーになる）

空ブランチを作る例

上記の手順でブランチを作ると、既にあるファイルもそのまま引き継がれる。[2013-02-01]
gh-pagesではmasterブランチとは全く違うファイルを管理したいこともあり、その場合は空のブランチを作れる方が都合が良い。

• 参考
  • 実践GitHub Pages運用のユースケースとワークフローの詳細
  • kanonjiさんのGithubのProject Pagesを作る手順を調べてみた。もしくはgitで空ブランチを作る方法を調べてみた。

$ cd sandbox
$ git symbolic-ref HEAD refs/heads/gh-pages
$ rm .git/index
$ git clean -fdx

$ vi 〜		←何らかのファイルを作成
$ git add .
$ git commit

$ git branch	←確認（コミットすると、作成したブランチが出てくる（コミットしないと出てこない））
* gh-pages
  master

$ git push origin gh-pages