フッタータグリスト
サイトフッターのカラムブロックとしてタグボキャブラリを読者に公開するオプトイン機能。
概要
フッタータグリストは、既存のフッターグリッドの中にレンダリングされるタグの索引です。読者は今開いているドキュメントから離れずに、常にすべてのタグページへアクセスできるようになります。
この機能はデフォルトでオフです。src/でfooter.taglist.enabledをtrueにするまで、フッターの見た目は従来と変わりません。ページごとのタグバッジ行やトップページの”All Tags”セクションも影響を受けません。
有効化
既存のfooter設定にtaglistブロックを追加します。
footer: {
links: [
// ...existing footer link columns
],
copyright: `Copyright © ${new Date().getFullYear()} Your Project.`,
taglist: {
enabled: true,
title: "Tags",
groupBy: "group",
groupTitles: {
topic: "By topic",
type: "By type",
level: "By level",
},
locales: {
ja: {
title: "タグ",
groupTitles: {
topic: "トピック別",
type: "種類別",
level: "レベル別",
},
},
},
},
},enabled以外のフィールドはすべて任意です。省略した項目には妥当なデフォルトが適用されます。
groupBy: "group"と"flat"
タグリストは2つのモードでレンダリングできます。
groupBy: "group"— ボキャブラリのgroupごとに1カラム。順序は<code>src/<wbr/>config/<wbr/>tag-<wbr/>vocabulary.<wbr/>ts</code>でその group が最初に登場する順です。ボキャブラリが有効なとき(tagVocabulary: trueかつtagGovernance !== "off")のデフォルトです。各カラムのタイトルはgroupTitles[<group>]から取られ、未指定なら group 名を先頭大文字にしたもの(topic→Topic)にフォールバックします。groupBy: "flat"—titleを見出しにした単一のアルファベット順カラム。ボキャブラリが無効のときは強制的にこれになります。タグがほんの少ししかなくグループ表示ではスカスカになる場合にも便利です。
タグが増えてグループ表示で topic と type が実際に分離されるようになったら"group"へ切り替えます。それまでは"flat"で十分です。
ロケールオーバーライド
タグリストが表示する文字列はカラムタイトルだけなので、ロケールオーバーライドは小さく保てます。localesマップは設定の<code>locales</code>と同じロケールコードをキーにします。
taglist: {
enabled: true,
title: "Tags",
groupTitles: { topic: "By topic", type: "By type", level: "By level" },
locales: {
ja: {
title: "タグ",
groupTitles: { topic: "トピック別", type: "種類別", level: "レベル別" },
},
},
},ロケールオブジェクトに存在するキーだけがデフォルトロケールの文字列を上書きし、無いキーはフォールバックします。タグ id そのものは翻訳されません——理由はtags ガイドの i18n セクションを参照してください。
読者に見える内容
少なくとも1つのドラフトでも unlisted でもないページから参照されているボキャブラリタグは、そのタグのインデックスページ(/または/)へのリンクとして表示されます。deprecated エントリはスキップされます。空のグループは折りたたまれ、埋めたカラムぶんだけ場所を取ります。