このテーマで個人サイトを構築する
このテーマはデータ駆動で構成されており、テンプレートから作られてはいません。依頼される変更のほとんどは、_config.yml の編集とフォルダへのファイル追加で完了します。もしレイアウトを編集し始めているなら、まずこのドキュメントを確認してください。おそらく、必要なフックはすでに存在しています。
1. 最速のパス:セットアップウィザード
npm run setup # ローカルフォームを開き、_config.yml を書き込み、置き換えたものをバックアップ
これは127.0.0.1にのみバインドし、データをアップロードすることは一切なく、置き換えたものはすべて .imprint-backup/<タイムスタンプ>/ にコピーします。現在の設定から事前入力されるため、後で再度実行しても安全です。
ウィザードでは、アイデンティティ、アクセントカラー、ヘッダーとフッター、ナビゲーション、ソーシャルリンク、コレクション、広告、アナリティクス、ニュースレターエンドポイント、ドメインを設定します。コレクションごとのページ構成は対象外で、それらのキーはそのまま引き継ぎます(§4参照)。
その後:
npm run dev # http://localhost:4000
npm run check # 診断 + プロダクションビルド
2. username.github.io へのデプロイ
- リポジトリ名を正確に
username.github.io(ユーザーページ)または任意の名前(プロジェクトページ)で作成します。 - このツリーを
mainブランチにプッシュします。 - Settings → Pages → Source: GitHub Actions を選択します。
.github/workflows/jekyll.yml はRuby 3.4でビルドし、_site/ をデプロイします。--baseurl "${{ steps.pages.outputs.base_path }}" を渡すため、同じワークフローがユーザーページ(ベースパス空)とプロジェクトページ(/リポジトリ名/)の両方で正しく動作します。baseurl をハードコードしないでください。
CNAME ファイルはカスタムドメインを保持します。カスタムドメインがない場合はファイルを削除してください。ウィザードではドメインを空白にした場合にこれを自動で行います。
3. コレクションの追加
コレクションはコンテンツの種類です。ブログ、ポートフォリオ、ポッドキャスト、機材の棚など。_config.yml の collections: 以下に追加します:
recipes:
output: true
title: Recipes
singular: Recipe
description: "このコレクションについての一行説明。"
permalink: /recipes/:name/
landing: /recipes/
icon: cooking-pot # phosphoricons.com のアイコン名
schema: Recipe # schema.org タイプ(JSON-LD用)
card: blog # 使用するカードデザイン(§5参照)
hero: { pattern: dots } # ランディングヒーロー;コンパクトヘッダには `hero: false`
image: "/assets/img/covers/recipes.svg"
single: # エントリーページの構成(§4参照)
lead: cover
parts: [breadcrumbs, head, lead, prose, tags, share, ask, author, nav]
widgets: [toc, collection, about]
その後:
mkdir _recipes # Jekyllが読み取るフォルダ
# コレクションを一覧表示するランディングページ:
printf -- '---\nlayout: page\ntitle: Recipes\npermalink: /recipes/\nlist_collection: recipes\n---\n' > recipes.html
npm run thumbs # 新しいコレクションのカバーアートを生成
npm run doctor を実行すると、これらの手順が漏れているかどうかを教えてくれます。
このテーマには13のコレクションが標準で含まれています:posts、portfolio、videos、snippets、prompts、webseries + episodes、courses + lessons、podcast、newsletter、travel、uses。子コレクション(エピソード、レッスン)はフロントマターのスラグ(series: または course:)によって親に属します。
4. エントリーページの構成を変更する
多くの人が新しいレイアウトが必要だと思う部分です。しかし、そうではありません。
single:
lead: portfolio # _includes/leads/portfolio.html
parts: [breadcrumbs, head, lead, prose, tags, share, ask, comments, author, nav]
widgets: [details, toc, collection, cta]
sidebar: true
parts→_includes/single/<名前>.htmlに、指定された順序で積み重ねられますwidgets→_includes/widgets/<名前>.htmlに、サイドバーに沿って配置されますlead→_includes/leads/<名前>.html(noneでリードなし)
ファイルをドロップして名前を付けることで、新しいパーツを自由に作成できます。 レイアウトを編集する必要は一切ありません。どのエントリーでも、自身のフロントマターでこれら3つすべてを上書きできます。
標準搭載のパーツ:breadcrumbs head toc-mobile lead prose tags share ask comments author nav episodes lessons siblings。
ウィジェット:toc details collection about cta share subscribe ad。
リード:cover video prompt snippet portfolio series audio。
5. カードデザイン
コレクションの card: <名前> で _includes/cards/<名前>.html を選択します。標準搭載:blog(編集記事)、portfolio(リポジトリカード)、video(プレーヤー)、snippet(コードウィンドウ)、prompt(チャットウィンドウ)、webseries(縦長ポスター)、episode、course、lesson、podcast、issue、trip、product。未設定の場合は blog にフォールバックするため、新しいコレクションは独自のデザインがなくても問題なく表示されます。
グリッド行内のカードは常に同じ高さになります。 .im-cards は各アイテムを引き伸ばし、カードのボディが余分なスペースを吸収します。そのため、新しいカードはボディに flex: 1 を、フッターに margin-top: auto を設定するだけでOKです。
6. タグページ
_plugins/tag_pages.rb は、すべてのコレクションにわたって、タグごとに /tags/<スラグ>/ のページを生成します。Jekyll自身の site.tags は投稿のみを対象とするため、映画や機材にもタグ付けしているサイトでは、実際にタグを持つアイテムの3分の1しか表示されないことになります。タグはスラグでグループ化されるため、Analytics と analytics は同じ主題として扱われます。
_plugins/ ジェネレーターは、私たちがJekyllを呼び出すたびに実行されます(.github/workflows/jekyll.yml も同様)。これはGitHubのレガシーな「ブランチからのビルド」Pagesモードでは実行されません。その場合は tag_pages: false を設定すると、タグリンクは /tags/ 上のアンカーにフォールバックします。
7. ハウススタイル — CSSを書く前に読んでください
このテーマは Im Design System に従っており、インタラクションは正確に2つだけです:
- ホバー — 要素が塗りつぶされる(
--im-hover-bg)。境界線がシャープになったり、3%大きくなったり、ドロップシャドウがかかったりすることはありません。 - 現在地 — 「現在地です」:より強い塗りつぶしと太いラベル(
--im-current-bg/-fg/-weight)。色の変更は行われません。
アクセントカラーは、プライマリボタン、リンクのホバー、フォーカスリング、選択範囲、そして各コレクションの派生色にのみ使用されます。それ以外には使いません。塗りつぶしボタンとカードは、どちらもちょうど1ピクセル浮き上がり、1本のヘアラインを落とします。
すべては --im-* カスタムプロパティで表現され、リテラルカラーは使用しません。_sass/im/abstracts/_mixins.scss には両方のインタラクションが一度だけ記述されています。
8. コマンド一覧
npm run setup # ブラウザセットアップフォーム
npm run dev # ローカルサーバー + ライブリロード
npm run build # プロダクションビルド(_site/ に出力)
npm run new # 任意のコレクションにエントリーを追加(雛形生成)
npm run thumbs # アクセントカラーからカバーアートを(再)生成
npm run doctor # ビルドを壊す設定ミスをチェック
npm run test # 設定/ウィザードのテストスイート
npm run check # doctor + build、つまりCIが行うこと
Ruby 3.4が必要です(.ruby-version に指定)。macOSシステムのRuby 2.6ではこのサイトをビルドできません。bin/serve と bin/build は、PATHに正しいツールチェーンを強制的に設定します。