Riebeckite
Menu
Color mode

Taxonomy

タグやフォルダなどの分類情報から一覧ページを提供する Plugin です。

導入

bash
npm install @riebeckite/plugin-taxonomy

Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は riebeckite.config.ts の plugins に登録して利用します。

使用例

frontmatter のタグなどを使ってコンテンツを分類し、同じ分類の記事をまとめて辿れるようにします。

yaml
---
tags:
  - flutter
  - architecture
---

タグを持つノートは /tags/<slug>/、フォルダ配下は /folders/<path>/ のページとして生成され、タグごとの RSS/Atom/JSON フィードも出力されます。

使いどころ

この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。

実際の表示例が用意されている場合は、Plugin Showcase でも確認できます。

詳細仕様

設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは Plugin System、Plugin を作る場合は Writing a Plugin を参照してください。

History

1 changesCollapseExpand
1 + # Taxonomy
2 +
3 + タグやフォルダなどの分類情報から一覧ページを提供する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-taxonomy
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + frontmatter のタグなどを使ってコンテンツを分類し、同じ分類の記事をまとめて辿れるようにします。
16 +
17 + ```yaml
18 + ---
19 + tags:
20 + - flutter
21 + - architecture
22 + ---
23 + ```
24 +
25 + タグを持つノートは `/tags/<slug>/`、フォルダ配下は `/folders/<path>/` のページとして生成され、タグごとの RSS/Atom/JSON フィードも出力されます。
26 +
27 + ## 使いどころ
28 +
29 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
30 +
31 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.ja.md) でも確認できます。
32 +
33 + ## 詳細仕様
34 +
35 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。
36 +
37 +