Riebeckite
Menu
Color mode

Series

連載記事に順序付きの前後ナビと一覧ページを追加する Plugin です。

導入

bash
npm install @riebeckite/plugin-series

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

使用例

各パートの frontmatter に series のキーを追加します。

yaml
---
title: Installing the thing
series: Build a thing
series_order: 2
---

2 パート以上の連載では、所属する各ノートに全パートを順番に並べたナビゲーションが付きます。あわせて /series の一覧ページと、連載ごとのランディングページを生成します。

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Series
2 +
3 + 連載記事に順序付きの前後ナビと一覧ページを追加する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-series
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + 各パートの frontmatter に series のキーを追加します。
16 +
17 + ```yaml
18 + ---
19 + title: Installing the thing
20 + series: Build a thing
21 + series_order: 2
22 + ---
23 + ```
24 +
25 + 2 パート以上の連載では、所属する各ノートに全パートを順番に並べたナビゲーションが付きます。あわせて `/series` の一覧ページと、連載ごとのランディングページを生成します。
26 +
27 + ## 使いどころ
28 +
29 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
30 +
31 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.md) でも確認できます。
32 +
33 + ## 詳細仕様
34 +
35 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.md) を参照してください。
36 +