CODE HOUSE


Hello, I'm a freelance software engineer.


[Hugo] github pagesについて

github pagesについて

https://pages.github.com/

リポジトリの内容をそのままwebとして公開できるgithub pagesについて調べてみた。github pagesには次の2つがあるようだ。

  • User site
  • Project site

※User siteと似たようなものに、Organization siteというのがある。これは、登録ユーザが組織の場合のサイトであるが、今回の説明では省略する。

User site

  • User siteは、githubに登録しているユーザが1つだけ持つことができるgithub pagesである。
  • 仕組みは簡単で、ユーザ名.github.ioという名前のリポジトリにファイルを置くだけである。
  • https://ユーザ名.github.io というURLでページが表示される。
  • 表示されるのは、masterブランチ。

※https://ユーザ名.github.com というURLだったようだが、.ioに変わったようだ。今は.comにアクセスすると.ioにリダイレクトされる。

Project site

  • ユーザ名.github.io以外のリポジトリをgithub pagesとして公開できるようにしたもの。
  • リポジトリにgh_pagesというブランチを作りファイルを置く。
  • https://ユーザ名.github.io/リポジトリ名 というURLでページが表示される。
  • 表示されるのは、gh_pagesブランチ。(masterではない)

実際の運用

User siteでは、gitgub pagesの元になるファイル群と、実際に公開するファイル群でそれぞれ別のリポジトリを作成するのがいいと思われる。 (試してはいないが、元ファイルをmaster以外、公開ファイルをmasterにすれば、1つのリポジトリでも運用できるかもしれない) 具体的にHugoでこのサイトを公開している私の場合、 mm-git/hugoに元ファイルを置いている。そしてHugoが生成したpublicフォルダをmm-git/mm-git.github.ioに置くようにしている。