強火で進め

このブログではプログラム関連の記事を中心に書いてます。

GitHub で Web サイトを無料で公開できるサービス「GitHub Pages」

GitHub Pages は GitHub が提供しているサイト公開の機能です。

GitHub Pages - Websites for you and your projects, hosted directly from your GitHub repository. Just edit, push, and your changes are live.
https://pages.github.com/

サイトは「ユーザのサイト」と「リポジトリに対応するサイト」の2種類のものが公開できます。ここでのユーザとは GitHub にアカウントを持っているあなた自身の事です。

ユーザのサイト

「ユーザのサイト」は自己紹介文やブログ記事、自分のリポジトリ一覧&解説を記述する事などに使うと良いでしょう。

GitHub も Jekill を使ってブログを書こうと紹介してたりします。

自分はまだ使った事が無いですがJekill は Ruby 製のツールみたいです。使って観たい人は「Jekill GitHub Page」辺りで検索すると良いでしょう。

リポジトリに対応するサイト

リポジトリに対応するサイト」はリポジトリでメンテナンスしてるアプリの公開やアプリの操作説明などを公開するサイトとして使うと良いでしょう。

※ private リポジトリで作成した場合にも GitHub Pages のサイトは世界に向けて公開状態になるので private リポジトリの場合には代わりに Wiki の機能などを使った方が良いでしょう。

ユーザのサイトの作り方

ユーザのサイトを作るのはとても簡単です。特定のリポジトリ名のリポジトリを作成するだけです。

作成手順

1. ユーザ名.github.io という名前のリポジトリを作成する。
※例えば GitHub のユーザ名(アカウント名)が hoge の場合には hoge.github.io で作成。
2. そこに .html や .md (マークダウン) ファイルを Push する。

公開URLは https://ユーザ名.github.io/ と成ります。

使用例:https://nakamura001.github.io/

リポジトリに対応するサイトの作り方

リポジトリに対応するサイトは現在は以下の3つの方法が取れます。

(A) master ブランチを使う
(B) master ブランチの docs フォルダを使う
(C) gh-pages ブランチを使う

テキストしか使わないサイトを作る場合にはどれを使っても問題有りません。
しかし、サイトで使う画像ファイルをリポジトリ内に置いておきたい場合には (B) を使うのがオススメです。

その様なサイトで (A) や (C) を使うとリポジトリに置かれた画像ファイルを初めて見た人がプログラム用かサイト用か簡単に見分ける事が出来なくなり、ドキュメントを除いてコードを使うのが大変になります。

作成手順

リポジトリのトップページを開き、 Settings をクリック。

GitHub Pages のブロックに有る Source で紹介した3種類のものから自分が使いたい種類のものを選択。画面が更新され後に再度 GitHub Pages のブロックに戻ると上部に公開URLが表示が追加されています。

使用例:
https://nakamura001.github.io/Unity-TestGamePad/

簡単に見栄えの良いサイトを作る方法

テーマが準備されており、そのテーマを使用すると簡単に見栄えの良いサイトを作成できます。

Settings のページを開き、 GitHub Pages のブロックに有る「Choose a theme」ボタンをクリック。

自分の好きなテーマを選び「Select theme」をクリック。

テーマを選ぶと _config.yml ファイルと README.md が自動的にリポジトリに追加されます。

設定後にサイトを確認するとテーマの選択画面には表示されている配布用の圧縮ファイルのアイコンが存在していない事に気が付くかと思います。

このアイコンを表示したい場合には _config.yml ファイルに show_downloads: true の行を追加すればOKです。

サイトのタイトル名は自動的にリポジトリ名に成ります。これを変更したい場合には title: タイトル名 の記述を追加します。

【 _config.yml の記述例】

theme: jekyll-theme-merlot
show_downloads: true
titile: 凄いアプリ配布サイト

制限

無料で提供されているこの様なサービスの場合、転送量や容量の制限が気になる所ですがその辺りは以下の様に成っています。

また、暴力的なものやわいせつなコンテンツを公開する事は禁止されています。

詳しくは以下のページを参照。

What is GitHub Pages? - User Documentation
https://help.github.com/articles/what-is-github-pages/

関連情報

Bitbucket で Web サイトを無料で公開できる機能を使う - 強火で進め
http://d.hatena.ne.jp/nakamura001/20170209/1486633793