Riebeckite
Menu
Color mode

Rich Embed

外部リンクなどを通常のリンクより情報量の多い埋め込みとして表示する Plugin です。

導入

bash
npm install @riebeckite/plugin-rich-embed

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

使用例

外部ページへのリンクを、URLだけではなくタイトルや概要を含むリッチなカードとして見せたい場合に利用します。

ソース

markdown
```embed
https://www.youtube.com/watch?v=dQw4w9WgXcQ
title: Demo video
caption: A short caption
aspect: 16/9
```

実行例

A short caption

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Rich Embed
2 +
3 + 外部リンクなどを通常のリンクより情報量の多い埋め込みとして表示する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-rich-embed
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + 外部ページへのリンクを、URLだけではなくタイトルや概要を含むリッチなカードとして見せたい場合に利用します。
16 +
17 + ### ソース
18 +
19 + ````markdown
20 + ```embed
21 + https://www.youtube.com/watch?v=dQw4w9WgXcQ
22 + title: Demo video
23 + caption: A short caption
24 + aspect: 16/9
25 + ```
26 + ````
27 +
28 + ### 実行例
29 +
30 + ```embed
31 + https://www.youtube.com/watch?v=dQw4w9WgXcQ
32 + title: Demo video
33 + caption: A short caption
34 + aspect: 16/9
35 + ```
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 +