Riebeckite
Menu
Color mode

QR Code

コンテンツ内で QR コードを生成・表示する Plugin です。

導入

bash
npm install @riebeckite/plugin-qr-code

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

使用例

記事内のURLや文字列をQRコードとして提示したい場合に利用します。スマートフォンへURLを渡したい手順書やイベント資料などで利用できます。

ソース

md
```qr
# caption: Project page
https://example.com/
```

実行例

Project pagehttps://example.com/

動作

qr フェンスは、QR コード、任意のキャプション、元のペイロードの順に描画します。ペイロードは常にアクセシブルなテキストとして残し、http、https、mailto、tel のときだけリンクにします。それ以外の値はリンクにせずテキストのまま表示します。

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # QR Code
2 +
3 + コンテンツ内で QR コードを生成・表示する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-qr-code
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + 記事内のURLや文字列をQRコードとして提示したい場合に利用します。スマートフォンへURLを渡したい手順書やイベント資料などで利用できます。
16 +
17 + ### ソース
18 +
19 + ````md
20 + ```qr
21 + # caption: Project page
22 + https://example.com/
23 + ```
24 + ````
25 +
26 + ### 実行例
27 +
28 + ```qr
29 + # caption: Project page
30 + https://example.com/
31 + ```
32 +
33 + ## 動作
34 +
35 + `qr` フェンスは、QR コード、任意のキャプション、元のペイロードの順に描画します。ペイロードは常にアクセシブルなテキストとして残し、`http`、`https`、`mailto`、`tel` のときだけリンクにします。それ以外の値はリンクにせずテキストのまま表示します。
36 +
37 + ## 使いどころ
38 +
39 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
40 +
41 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.ja.md) でも確認できます。
42 +
43 + ## 詳細仕様
44 +
45 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。
46 +
47 +