はじめに
GitHub Pages聞いたことはあったけど、一から自分で作ったことなかった人の
2018年10月時点のまとめです
割と古めの記事が多かったので、改めて今の情報を整理してみました。
まとめ
- GitHub Pagesには大きく分けて2種類ある（ユーザ/組織 or プロジェクト）
- それぞれできることが微妙に違う
- 手早く簡単に作って、楽して運用するならプロジェクトのタイプで作ると楽
組織というとピンときにくいかもしれませんが
GitHubのorganizationのことです。
ざっくり比較表
先に一覧で見てから個別にフォローしていきます。
| ユーザ/組織 | プロジェクト | |
|---|---|---|
| リポジトリ名 |
<username or org>.github.io |
任意のモノが可能 |
| 公開ブランチ | masterのみ | master/masterのdocsディレクトリ/gh-pages |
| 生成されるURL | https://<username or org>.github.io |
https://<username or org>.github.io/<projectname>
|
| カスタムドメイン | 利用可能 | 利用可能 |
リポジトリ名
▼ユーザ/組織の場合
フォーマットの沿ったリポジトリ名にする必要があります。
このフォーマットに沿った名前の場合はGitHub Pagesとして公開するとして、
ページ公開設定も自動で入ります。
▼プロジェクトの場合
お好きなリポジトリ名で大丈夫です
公開するブランチ
▼ユーザ/組織の場合
masterのみです。masterの直下を公開することになります。
HUGOなどで特定のディレクトリに吐き出す系だと、masterの直下にいろいろ展開される必要があり、あまりおもしろくありません...
▼プロジェクトの場合
リポジトリにファイルが登録されたら,3つの選択肢から選べます。
- master（これはユーザ/組織の場合と同じ）
- masterのdocsディレクトリ（masterブランチの特定のディレクトリのみ公開できる）
- gh-pages（masterブランチでなく違うブランチで公開内容を管理したい時）
HUGOなどの静的ファイルのgeneratorと組み合わせる場合、
特定のディレクトリを公開できたほうがルートディレクトリにファイルがあふれなくて都合がよい
生成されるURL
▼ユーザ/組織の場合
以下のような感じです。ポートフォリオなど、個人にフォーカスをあてるならこのURLがよいと思う。
https://<username or org>.github.io
▼プロジェクトの場合
以下のような感じです。特定のリポジトリの説明とかにはこの形式がよさそうですね
https://<username or org>.github.io/<projectname>
カスタムドメイン
これはどちらの場合も設定できるようです。
雑なまとめ
個人のポートフォリオ程度を簡単に作成・運用するならプロジェクトページで
masterブランチのdocsディレクトリ公開の設定がいいと思います。
URLはプロジェクト名が入る分、長くなるのが微妙ですが、
HUGOなどと合わせた時も、ルートディレクトリに直接展開するのは避けたい。