Properties

ノートのプロパティや frontmatter に含まれる情報を公開ページで扱いやすくする Plugin です。

導入

npm install @riebeckite/plugin-properties

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

使用例

frontmatter に書いた記事の属性を、公開ページでも扱いたい場合に利用します。

---
title: Riebeckite Guide
author: Rerurate
tags: [riebeckite, docs]
---

frontmatter の値は、記事の先頭（設定により末尾）にプロパティパネルとして表示されます。タグはリンク、日時は <time>、真偽値やネストした値も型に合わせて描画されます。

使いどころ

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

詳細仕様

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

History

1 changesCollapseExpand

From To

	1	`+ # Properties`
	2	`+`
	3	`+ ノートのプロパティや frontmatter に含まれる情報を公開ページで扱いやすくする Plugin です。`
	4	`+`
	5	`+ ## 導入`
	6	`+`
	7	+ ```bash
	8	`+ npm install @riebeckite/plugin-properties`
	9	+ ```
	10	`+`
	11	+ Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
	12	`+`
	13	`+ ## 使用例`
	14	`+`
	15	`+ frontmatter に書いた記事の属性を、公開ページでも扱いたい場合に利用します。`
	16	`+`
	17	+ ```yaml
	18	`+ ---`
	19	`+ title: Riebeckite Guide`
	20	`+ author: Rerurate`
	21	`+ tags: [riebeckite, docs]`
	22	`+ ---`
	23	+ ```
	24	`+`
	25	+ frontmatter の値は、記事の先頭（設定により末尾）にプロパティパネルとして表示されます。タグはリンク、日時は `<time>`、真偽値やネストした値も型に合わせて描画されます。
	26	`+`
	27	`+ ## 使いどころ`
	28	`+`
	29	`+ この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。`
	30	`+`
	31	`+ ## 詳細仕様`
	32	`+`
	33	`+ 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。`
	34	`+`
	35	`+`