Edited at

Hugo + Github Pagesでブログを公開してみた

More than 3 years have passed since last update.


hugoでブログをやってみる

ブログをやってみようと思った時に、ここはRuby書いてる人っぽくjekyllでやってみるか!って思って調べてたら、もっと良さそうなものを見つけた。gitでリポジトリをプッシュするだけで簡単にブログ記事をあげられる&記事の生成がめっちゃ早いということで評判が良かったので、hugoを使ってみることにしました。そして、ドハマりしたうえ日本語の記事も少なかったのでメモ。


hugoの魅力


1. とにかく記事作成が楽

最終的にですが、ターミナルから以下の手順だけでGithub pagesにてブログが更新できます。

$cd ~/blog

#hugoによって生成されたディレクトリまで移動
$hugo new post/hugahoge.md
#新規マークダウンファイルの作成
$ ./deploy.sh
#色々なコマンドの入ったシェルスクリプトの実行(コピペで手に入る)
$ git push origin master
#hugoによって生成されたディレクトリのリポジトリをgithub pagesのリモートにプッシュ(これはホントはやらなくて良い手順のハズ・・・・)


2. --watchコマンドでオートリロード!!

hugoでは、以下のコマンドでlocalhost:1313からプレビューができます。この時、--watchコマンドを利用することでmdファイルを更新する度にブラウザ側のプレビューも自動で更新されます。

#hugoのルート・ディレクトリから・・・

$hugo server --watch -t hugo-zen
#--watchコマンド!

これがかなり便利です。いちいちcommand + r する手間が省けるのが素晴らしい。デュアルディスプレイとかwindow magnetとかで捗ります。


3.Markdown記法で気軽に書いて更新できる

これはjekyllなどでもそうですが、mdで書けるのは非常に楽です。普段からmdを書いているのもありますが、もう正直色をつけたり文字の大きさをいちいち変えたり「できる」というだけでまどろっこしいので。


4.記事の生成が早い

これは多くの人が言及しているので割愛。jekyllにはすごくお世話になっているのですが正直生成でストレスを感じたことはありません。上記のオートリロードが無いくらいですかね。


インストール ~ テーマの適用


インストール

とっても簡単。homebrewユーザーなら、以下のコマンドで。

$cd 

#ホームディレクトリに移動
$brew install hugo
#hugaじゃないよ

続いて、以下のコマンドで新たなhugoプロジェクトを作成。

$hugo new site <your_site_name>

#<>の部分は任意の名前を入れてね!
$cd <your_site_name>
#プロジェクトのルート・ディレクトリに移動しておきましょう


テーマの適用

このままビルドしても記事を作成することはできるのですが、最初からある程度デザインができている方が楽です。というわけで、テーマを適用しましょう。まずは以下のコマンドでテーマを利用できるようにします。

$git clone --recursive https://github.com/spf13/hugoThemes.git themes

#全てのテーマをダウンロード

今は全てのテーマをダウンロードしましたが、あとで利用するもの以外は削除してしまって構いません。

ところで、hugoはrailsなどと同じようにローカルでサーバーを立ち上げてプレビューすることができます。テーマは、その際にオプションで選択できます。


記事の作成

次に、試しに記事を作ってみます。

$hugo new post/hoge.md

#content/post/hoge.md が作成されます

生成されたmdファイルを適当に編集して、プレビューしてみましょう。以下のコマンドを打ちます。

$hugo server -t 使用したいテーマ名 --watch

#テーマを適用しつつ、プレビューを起動。例えば以下のように・・・
$hugo server -t simple-a --watch

使用したいテーマ名の部分には、themesというディレクトリに入っているテーマの名前を入れます。うまく動かないものもありますが、とりあえず良さそうなものがないか試してみましょう。

以下のように表示されれば成功です。(と思ったら画像がうまく表示できない・・・)

purehugo


github pagesで公開

ここが一番詰まりました。「サーバー立ち上げたらテーマが適用されるのね。ほう、publicディレクトリができてそこに静的ファイルが生成されるとな?」とまでは良かったのですが、そもそもgithub pagesを使ったことがなかったのでその仕組みを知るのに一苦労。そして、いい感じのurlで表示できるようになるまでにまた一苦労。

基本的には、以下のhugoの公式docを読めばなんとかなるっぽいですが。

Github Pagesへのセットアップ

よくわからなかったので、いろんな記事を参考に自分なりにやりました。これから紹介する方法は不完全ですので、完全版を教えていただけますと大変助かります(汗


リポジトリを2つ作成

まずはgithub上で、リモートリポジトリを2つ作ります。1つは名前はなんでも大丈夫です。もう一つは公開用なのでgithub pagesの規約どおりに作ります。ここでは前者から

hogehuga

username.github.io

とします。

2つのリモートリポジトリが作れたら、次はhugoプロジェクトのルートディレクトリでローカルリポジトリを作り、先ほど作ったhogehugaの方にaddします。すでにプレビューをしているなら、ルートディレクトリ下にpublicフォルダができていますが、こちらは消しておく必要があります。

$cd ~/blog

#プロジェクトのルート・ディレクトリに移動
$rm -rf public
#publicフォルダを削除
$git init
#gitコマンドでローカルリポジトリを作成
$git remote add origin https://github.com/<githubのuser名>/hogehuga.git
$git add .
#カレントディレクトリ以下を全てadd
$git commit -m "first commit"
#コミット
$git push origin master
#プッシュ

続いてGithub Pagesの表示で利用するリポジトリのpublicフォルダをhogehugaのサブモジュールとして追加します。なので、もう一度publicフォルダを作り直します。そのために、ビルドのコマンドを打ちます。ここでは、hugo -t テンプレート名とすると再びpublicフォルダを作成できます。

$hugo -t <テンプレート名>

#publicフォルダに静的ファイルを生成
$git submodule add git@github.com:<githubのユーザー名>/<githubのユーザー名>.github.io.git public
#サブモジュールとしてpublicフォルダを追加

gitのサブモジュールっていうのはあくまで本体の一部のディレクトリを別のリポジトリで管理するものだと思ってましたが、hugoのページを読んでいるとどうも本家の方を更新することで本家のサブモジュールであるpublicも更新されて結果が反映される、みたいなノリなんですよね。よくわからない。。

ここまで来たら、プロジェクトのルート・ディレクトリに以下の内容のシェルスクリプトdeploy.shを作成します。途中記事をビルドするhugoの後に、 -tオプションでテーマを指定することを忘れないでください。

#deploy.shの中身

#!/bin/bash

echo -e "\033[0;32mDeploying updates to GitHub...\033[0m"

# Build the project.
hugo # if using a theme, replace by `hugo -t <yourtheme>`

#↑ここを変更しましょう!!

# Go To Public folder
cd public
# Add changes to git.
git add -A

# Commit changes.
msg="rebuilding site `date`"
if [ $# -eq 1 ]
then msg="$1"
fi
git commit -m "$msg"

#Push source and build repos.
git push origin master

# Come Back
cd ..

あとは冒頭で示した通り、deploy.shを実行し、本体をプッシュすることでhugoのプロジェクトが更新されます。

#hugoプロジェクトのルートディレクトリから・・・

$./deploy.sh
#deploy.shの実行
$git push origin master
#本体もプッシュする

いよいよ、Github Pagesにアクセスしてみましょう。先ほど作成したリポジトリの名前がそのままurlになっていますので、gitのusername.github.ioというurlでいけるはずです。

無事、hugoのブログが表示されたでしょうか。

ちなみに僕のはこちらです。


感想

本当ならddploy.shを実行するだけでいけるはず?また、画像の表示がうまくいかない、カテゴリーやタグ付けのやり方がわからないなど、まだやることはいっぱいですが、とりあえず楽にmdで書けるブログが手に入ったのは非常に良かったです。まだaboutページもないしコメントも書けないので、ちょいちょいカスタマイズしていきます。


謝辞

本ブログのテーマはrakuishi様のhugo-zenをほんの少しカスタマイズして利用しています。どうもありがとうございます!!