この記事の目的
Github pagesでサイトを公開する時の備忘録です。
アカウントによる制限
- フリーアカウントの場合
- Publicなリポジトリでのみサイトを作成できる。
- 有料アカウントの場合
- public/privateどちらでも。
既存のリポジトリから公開手順
①index.mdを作成する
マスターブランチのトップディレクトリにindex.mdをpushするだけです。
index.htmlでもいいのですが、mdとすると、jykyllがうまいことジェネレートしてくれるので便利です。
mdはマークダウン記法のファイルですので、マークダウンチートシートなどを参考に作成します。
試しに下記のようなindex.mdを作成してみました。
index.md
②GitHub Pagesの設定をenableにする。
Setting > GitHub Pages の設定をenableにします。そうするとURLが発行されるのでコピーします。
③テーマを選択する。
④ブラウザから開く
ブラウザから開けばアクセスできます。
実際の表示
リポジトリをprivateからpublicに変換する場合
Setting > Change repository visibility >Make public
テーマとか設定とかを変える
テーマを選択するとトップディレクトリに_config.ymlが作成されるので、このファイルをいじれば色々とカスタイマイズ出来ます。
オプションとパラメータは、下記のjekyllのサイトを参考にします。
ページのタイトルを設定する
yaml フロントマターが使える。
https://jekyllrb.com/docs/front-matter/
index.mdのヘッドに下記を記述すればOKです。
---
# YAML Front Matter
title: my first jekyll site
---