Color mode

Attachment

Markdown から参照される添付ファイルを公開サイトで扱うための Plugin です。

導入

bash
npm install @riebeckite/plugin-attachment

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

使用例

ノートから PDF や ZIP などの添付ファイルへリンクし、公開サイトから参照できるようにする用途です。

markdown
[[files/specification.pdf|仕様書を開く]]
[[files/example.zip|サンプルを取得]]

[[file]] はダウンロードリンク、![[file]] はファイルサイズ付きの添付カードとして展開されます。

使いどころ

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Attachment
2 +
3 + Markdown から参照される添付ファイルを公開サイトで扱うための Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-attachment
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + ノートから PDF や ZIP などの添付ファイルへリンクし、公開サイトから参照できるようにする用途です。
16 +
17 + ```markdown
18 + [[files/specification.pdf|仕様書を開く]]
19 + [[files/example.zip|サンプルを取得]]
20 + ```
21 +
22 + `[[file]]` はダウンロードリンク、`![[file]]` はファイルサイズ付きの添付カードとして展開されます。
23 +
24 + ## 使いどころ
25 +
26 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
27 +
28 + ## 詳細仕様
29 +
30 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.md) を参照してください。
31 +
32 +