PDF

PDF コンテンツや PDF 埋め込みを扱うための Plugin です。

導入

npm install @riebeckite/plugin-pdf

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

記事から PDF を参照したときに、単なる外部リンクではなく閲覧しやすい形で扱いたい場合に利用します。

[[documents/guide.pdf|資料]]

![[report.pdf]] はビルド時にページ内 PDF ビューアへ置き換わり、ダウンロード用リンクとファイル情報も併記されます。表示には PDF ファイルの配置が必要です。

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

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

1 changesCollapseExpand

From To

	1	`+ # PDF`
	2	`+`
	3	`+ PDF コンテンツや PDF 埋め込みを扱うための Plugin です。`
	4	`+`
	5	`+ ## 導入`
	6	`+`
	7	+ ```bash
	8	`+ npm install @riebeckite/plugin-pdf`
	9	+ ```
	10	`+`
	11	+ Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
	12	`+`
	13	`+ ## 使用例`
	14	`+`
	15	`+ 記事から PDF を参照したときに、単なる外部リンクではなく閲覧しやすい形で扱いたい場合に利用します。`
	16	`+`
	17	+ ```markdown
	18	`+ [[documents/guide.pdf\|資料]]`
	19	+ ```
	20	`+`
	21	+ `![[report.pdf]]` はビルド時にページ内 PDF ビューアへ置き換わり、ダウンロード用リンクとファイル情報も併記されます。表示には PDF ファイルの配置が必要です。
	22	`+`
	23	`+ ## 使いどころ`
	24	`+`
	25	`+ この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。`
	26	`+`
	27	`+ ## 詳細仕様`
	28	`+`
	29	`+ 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。`
	30	`+`
	31	`+`