Minimal Mistakes：個人サイト向けの2カラムJekyllテーマ

テーマが提供するもの

Minimal Mistakesは、個人サイト、ブログ、ポートフォリオ向けの2カラムJekyllテーマです。READMEは、スタイルを意図的にミニマルにして、サイト所有者が拡張・カスタマイズできるようにしていると説明しています。テーマは、シングルレイアウト、アーカイブインデックス、検索、スプラッシュ、ページネーション付きホームページなどのレスポンシブレイアウトオプションを備えています。ヘッダー画像、カスタムサイドバー、目次、ギャラリー、関連記事、パンくずリンク、ナビゲーションリストに対応しています。また、Disqus、Facebook、Google+、Discourse、Staticman、utterances、giscusなどのコメントシステム、Google AnalyticsとSwetrixによる分析機能も内蔵しています。UIテキストは30以上の言語にローカライズされており、デフォルトは英語です。テーマはJekyll内蔵のSass/SCSSプリプロセッサを使用しており、Jekyllのツールチェーンから離れることなくスタイルを調整できます。\n\nテーマを採用する前に、Gemfile と _config.yml に jekyll-include-cache が正しく登録されているかを確認し、小さな記事を一つだけビルドする。Unknown tag include_cached が出る場合は、テーマの見た目を調整するより先にプラグイン設定を直す必要がある。

スキンとビジュアルバリエーション

READMEには、デフォルトに加えて11の名前付きスキンがリストされています：air、contrast、dark、dirt、mint、sunrise、aqua、neon、plum、catppuccin_latte、catppuccin_mocha。各スキンはテーマのカラーパレットを変更します。スキンを選択する正確な設定キーはREADMEには記載されておらず、別途ドキュメントで扱われています。テーマはJekyll内蔵のSass/SCSSプリプロセッサも使用しており、既定のスキン以外にも深いスタイル変更が可能です。READMEは、スタイルはユーザーが拡張・カスタマイズすることを意図していると述べており、デフォルトの外観は意図的に控えめです。

jekyll-include-cache を含む導入手順

READMEには3つのインストール方法が記載されています。gemベースの方法では、Gemfileにgem "minimal-mistakes-jekyll"を追加し、bundleを実行し、_config.ymlでtheme: minimal-mistakes-jekyllを設定します。リモートテーマ方式はGitHub Pages向けで、github-pages gemを使用し、plugins配列にjekyll-include-cacheを追加し、bundleを実行し、_config.ymlでremote_theme: "mmistakes/minimal-mistakes@4.28.0"を設定します。3つ目の方法は、テーマファイルをフォークまたは直接コピーしてプロジェクトに取り込むことです。どの方法でも、jekyll-include-cacheプラグインが必要です。これがないと、ビルドは"Unknown tag 'include_cached'"エラーで失敗します。READMEの冒頭近くにその注意書きがあります。

設定とドキュメント

READMEは、設定、カスタマイズ、コンテンツ移行の詳細について、https://mmistakes.github.io/minimal-mistakes/docs/quick-start-guide/ にあるテーマのドキュメントを参照しています。また、テンプレートから新しいGitHub Pagesサイトを生成するリモートテーマスターターリポジトリへのリンクもあります。README自体には完全な設定スキーマは記載されておらず、それはドキュメントサイトに委ねられています。ユーザーはドキュメントを読んで、ナビゲーション、サイドバー、SEOなどの設定方法を学ぶ必要があります。READMEには更新用のCHANGELOGファイルへの言及もあります。

デモコンテンツとソース構造

リポジトリの /docs ディレクトリには、ドキュメントページとデモサイトの両方が含まれています。デモでは、ヘッダー画像付きの投稿、HTMLタグとフォーマットを含む投稿、シンタックスハイライトの投稿、ギャラリー付きの投稿、サンプルコレクションページ、カテゴリアーカイブ、タグアーカイブが表示されます。これらの例へのリンクはREADMEにあります。デモとドキュメントのソースファイルは /docs にあり、各レイアウトがどのように処理されるかを貢献者が確認できます。デモサイトには、追加のサンプル投稿の年別アーカイブもあります。

貢献と開発

READMEは、バグやタイプミスの報告のためにissueやpull requestを送るようユーザーに呼びかけています。初めての貢献者はGitHub Flowを読むように案内されています。開発ワークフローはbundle installから始まります。変更をテストするには、bundle exec rake previewを実行し、ブラウザで http://localhost:4000/test/ を開きます。サーバーはtest/ディレクトリのコンテンツを使用し、変更に応じて再生成されます。pull requestはmasterブランチに対して行う必要があります。READMEは、ブランチに意味のある名前を付け、pull requestで機能や修正を説明することを推奨しています。

ライセンスと同梱コンポーネント

Minimal MistakesはMITライセンスでリリースされており、著作権は2013-2024年のMichael Roseと貢献者に帰属します。ライセンスは、著作権表示を含めることを条件に、使用、コピー、変更、統合、公開、配布、サブライセンス、販売を許可します。ソフトウェアは「現状のまま」提供され、保証はありません。テーマには、The Noun Projectのアイコン（CC BY 3.0 US）、Font Awesome（SIL OFL 1.1およびMIT）、Unsplashの写真、Susy、Breakpoint、FitVids.js、Magnific Popup、Smooth Scroll、Gumshoe、jQuery throttle/debounce、GreedyNav.js、Jekyll Group-By-Array、Liquidベースの目次、Lunr、clipboard.jsなどのライブラリが含まれています。各コンポーネントのライセンスはREADMEに個別に記載されています。

編集部の結論

Minimal Mistakesは、ビジュアルの決定をサイト所有者に委ねる出発点を提供します。ドキュメントとデモコンテンツは一般的なレイアウトパターンをカバーし、MITライセンスは著作権表示を条件に再利用を許可します。採用する前に、テーマが依存するjekyll-include-cacheプラグインがホスティング環境でサポートされていることを確認してください。

公式情報源

1. Official documentation
2. Official README
3. Project repository
4. Release notes