GitHub Pages の作り方

GitHub Pages とは

GitHub が提供するホスティングサービス. GitHubリポジトリにファイルを置くだけで簡単に配信できる.

流れ

  1. リポジトリを作成する
  2. gh-pages ブランチを作成する
  3. 10 分程度経つとできてる!

リポジトリを作成する

https://github.com/new からリポジトリを作成する. このとき, リポジトリの名前がサイト URL に反映され, 以下のようになる.

http://${アカウント名}.github.io/${リポジトリ名}/

なお, ${アカウント名}.github.io という名前でリポジトリを作成すると,

http://${アカウント名}.github.io/

という URL になる.

ファイルを git で管理する

では, 早速リポジトリに push していく. まずローカルにディレクトリを作成する. 今回は sqrtxx.github.io リポジトリにアップしていく.

mkdir sqrtxx.github.io
cd sqrtxx.github.io

とりあえず index.html に一文だけ表示させてみる.

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>GitHub Pages</title>
  </head>
  <body>
    <h1>Welcome to GitHub Pages!</h1>
  </body>
</html>

git で管理する.

git init
git config user.name '${ユーザー名}'
git config user.email '${E-mail Address}'
git remote add origin git@github.com:sqrtxx/sqrtxx.github.io
git add index.html
git commit -m 'Add index.html'
git push origin master

${アカウント名}.github.io は master ブランチを参照するため, gh-pages ブランチは不要である.

gh-pages ブランチを作成する

こちらは ${アカウント名}.github.io 以外での操作である. gh-pages ブランチを作成する.

git checkout -b gh-pages
git push origin gh-pages

確認する

(10 分程度待つ).

http://sqrtxx.github.io

congratulation!

Reference