Breadcrumbs Plugin は、階層構造に従って、前のページへのリンクを追加する Grav Plugin です。
ブログを運営している場合は特に便利です。

インストール

Breadcrumbs Plugin は、GPM (Grav Package Manager) を使った、ターミナルのコマンドからのインストールと、zip ファイルを使ったインストールが可能です。

GPM Installation (Preferred)

このプラグインをインストールする最も簡単な方法は、Grav Package Manager (GPM) を使って、システムのターミナル (コマンドラインとも呼ばれます) からインストールする方法です。 Grav のルートからインストールする場合は、次のように入力します。

bin/gpm install breadcrumbs

実行すると、Breadcrumbs Plugin が Grav 内の /user/plugins ディレクトリにインストールされます。実際のファイルは /your/site/grav/user/plugins/breadcrumbs の下にあります。

Manual Installation

このプラグインをインストールするには、このリポジトリの zip 版をダウンロードして、 /your/site/grav/user/plugins の下に解凍してください。そのフォルダを breadcrumbs にリネームしてください。zip ファイルは GitHub または GetGrav.org で見つけることができます。

これで、すべてのプラグイン・ファイルが、以下の場所にあるはずです。

/your/site/grav/user/plugins/breadcrumbs

注意：このプラグインは Grav のモジュールコンポーネントで、動作には　Grav, Error, Problems プラグイン、およびテーマのインストールが必要です。

Usage

breadcrumbs plugin は、設定を行う必要はなく、インストールした瞬間にすぐに使うことができます。

パンくずの見た目を変えたい場合は、テンプレートファイル breadcrumbs.html.twig をカスタムテーマの templates フォルダにコピーすれば、それで完了です。

/your/site/grav/user/themes/custom-theme/templates/partials/breadcrumbs.html.twig

これにより、オーバーライドを編集して、好きなように微調整することができます。

Per-page Settings

以下のオプションは、ページの YAML frontmatter で使用することができ、breadcrumbs のマッピングに反映します。

ページごとの設定例

---
title: Some page you wrote
breadcrumbs:
  may_descend: false # このページの下にあるページにはパンくずが生成されません。
---

アップデート

Breadcrumbs プラグインの開発が進むにつれて、追加機能や新しい Grav リリースとの互換性が改善され、一般的により良いユーザーエクスペリエンスを提供する、新しいバージョンが利用可能になるかもしれません。Breadcrumbs の更新は簡単で、Grav の GPM システムから行うこともできますし、手動で行うこともできます。

GPM アップデート (おすすめ)

このプラグインをアップデートする最も簡単な方法は、Grav Package Manager (GPM) を利用することです。これは、システムのターミナル（コマンドラインとも呼ばれる）を使用して、Gravインストールしたルートディレクトリに移動し、次のように入力することで行うことができます。

bin/gpm update breadcrumbs

このコマンドは、Breadcrumbs プラグインが更新時期かどうかを確認するために、インストールされている Grav をチェックします。より新しいリリースが見つかった場合、アップデートするかどうか尋ねられます。続行するには、yと入力してEnterキーを押してください。プラグインは自動的にアップデートされ、Gravのキャッシュをクリアします。

手動アップデート

手動で Breadcrumbs を更新するのはとても簡単です。以下は、そのために必要なことです。

• your/site/user/plugins/breadcrumbs フォルダを削除します。
• Breadcrumbsプラグインの新バージョンは、以下のいずれかからダウンロードしてください。 GitHub or GetGrav.org.
• your/site/user/plugins に zip ファイルを解凍し、できたフォルダを breadcrumbs にリネームしてください。
• Grav のキャッシュをクリアします。最も簡単な方法は、ターミナルで Grav のルート・ディレクトリに行き、bin/grav clear-cache とタイプすることです。

注意: このディレクトリの下にあるファイルに対して行った変更は、すべて削除され、新しいファイルに置き換えられます。他の場所にあるファイル（例えば、user/config/pluginsに置かれたYAML設定ファイル）は、そのまま残ります。

Configuration

user/plugins/breadcrumbs/breadcrumbs.yaml を user/config/plugins/breadcrumbs.yaml にコピーして、修正するだけです。

enabled: true
show_all: true
built_in_css: true
include_home: true
include_current: true
icon_home: ''
icon_divider_classes: 'fa fa-angle-right'
link_trailing: false

オプションはみたままです。