Gem 化された Minimal Mistakes でブログシステムを構築するメモ

このブログで利用している Jekyll テーマの Minimal Mistakes が 4.0.4 のリリースで gem 化されていたので、最新バージョンにマイグレーションするついでに gem 化された Minimal Mistakes のテーマを利用してブログシステムを構築する方法についてまとめてみました。

Gem 化された Minimal Mistakes を利用する

ざっと手順を示すと、次のようになります。

1. Gemfile を用意して bundle install する
2. _data/navigation.yml を用意する
3. _config.yml を用意・編集する
4. index.html を用意する
5. 静的 HTML を生成する

Gemfile を用意して bundle install する

Quick-Start guide の Ruby Gem Method にあるとおり、まずは以下のような Gemfile を用意します。

source "https://rubygems.org"
gem "minimal-mistakes-jekyll"

bundle install は上記の Gemfile が配置されたディレクトリ上で例えば次のように実行します。

$ bundle install --path vendor/bundler

_data/navigation.yml を用意する

以前のブログエントリ でも記述しているとおり、masthead 部分に表示するメニューを _data/navigation.yml ファイルに記述することができます。何も表示するつもりがなければ、とりあえず main: とだけ記述したファイルを用意しておきましょう。

_config.yml を用意・編集する

Minimal Mistakes git リポジトリの _config.yml などをベースに、自身のサイトに関する設定を記述していきます。

具体的に、設定項目に何を記述するか (記述すればいいのか) については、Configuration か 以前のブログエントリ を参考にするといいでしょう。

なお、今回のように gem 化されたテーマを利用する場合は theme: minimal-mistakes-jekyll の記述をお忘れなく！

index.html を用意する

とりあえずは Minimal Mistakes git リポジトリの index.html をそのまま使っておきましょう。

静的 HTML を生成する

以下のコマンドを実行することで、 _site/ ディレクトリ以下に生成された HTML などが出力されます。

bundle exec jekyll build

こちらの HTML など一式を GitHub Pages 用の git リポジトリに push すれば公開完了です。

Gem 化された Minimal Mistakes を利用するメリット

従来はリリースされた ZIP アーカイブを利用したり、git リポジトリを clone して Minimal Mistakes のテーマを利用する必要がありました。 それらの方法と比較して gem を利用する方法は、環境構築の手間がより少なく済むこと、そして Minimal Mistakes のバージョンアップが容易になる ことがメリットとして考えられます。

Gem 化されるまでの Minimal Mistakes では、細かなカスタマイズを施して利用する場合にオリジナルのファイルを直接編集する必要があり、これが (手動マージを要求されるという観点で) バージョンアップ作業を妨げる一つの要因になっていました。この問題が解消されることで、(Minimal Mistakes 側に破壊的な構造的変更がなければ) 頻繁なバージョンアップができるようになるものと考えられます。