Canvas

Obsidian Canvas の内容を公開ページ内で表示するための Plugin です。

導入

npm install @riebeckite/plugin-canvas

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

Obsidian Canvas で作成した情報を、ノート本文だけでなく公開サイトでも参照・表示したい場合に利用します。Canvasファイルを含むVaultを公開するケースが代表例です。

canvas のコードブロックや ![[diagram.canvas]] は、ビルド時にキャンバス表示へ置き換わります。render オプションで、静的 SVG・インタラクティブ・両方から描画方式を選べます。

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

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

1 changesCollapseExpand

From To

	1	`+ # Canvas`
	2	`+`
	3	`+ Obsidian Canvas の内容を公開ページ内で表示するための Plugin です。`
	4	`+`
	5	`+ ## 導入`
	6	`+`
	7	+ ```bash
	8	`+ npm install @riebeckite/plugin-canvas`
	9	+ ```
	10	`+`
	11	+ Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
	12	`+`
	13	`+ ## 使用例`
	14	`+`
	15	`+ Obsidian Canvas で作成した情報を、ノート本文だけでなく公開サイトでも参照・表示したい場合に利用します。Canvasファイルを含むVaultを公開するケースが代表例です。`
	16	`+`
	17	+ canvas のコードブロックや `![[diagram.canvas]]` は、ビルド時にキャンバス表示へ置き換わります。`render` オプションで、静的 SVG・インタラクティブ・両方から描画方式を選べます。
	18	`+`
	19	`+ ## 使いどころ`
	20	`+`
	21	`+ この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。`
	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	`+`
	27	`+`