Riebeckite
Menu
Color mode

Folder Pages

フォルダの entry ノートをランディングページにし、entry のないフォルダには一覧ページを生成する Plugin です。

導入

bash
npm install @riebeckite/plugin-folder-pages

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

使用例

docs やノートの Vault で、フォルダごとにランディングページを持たせたい場合に利用します。<folder>/README.md または <folder>/index.md が /folder/ のランディングページになり、元の /folder/README の URL はリダイレクトされます。entry ノートのないフォルダには、直下のページとサブフォルダを並べたページが自動生成されます。

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Folder Pages
2 +
3 + フォルダの entry ノートをランディングページにし、entry のないフォルダには一覧ページを生成する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-folder-pages
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + docs やノートの Vault で、フォルダごとにランディングページを持たせたい場合に利用します。`<folder>/README.md` または `<folder>/index.md` が `/folder/` のランディングページになり、元の `/folder/README` の URL はリダイレクトされます。entry ノートのないフォルダには、直下のページとサブフォルダを並べたページが自動生成されます。
16 +
17 + ## 使いどころ
18 +
19 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
20 +
21 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.ja.md) でも確認できます。
22 +
23 + ## 詳細仕様
24 +
25 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。
26 +