Riebeckite
Menu
Color mode

Shortcodes

:name（インライン）、::name（ブロック）、:::name（ブロックコンテナ）ディレクティブを、shortcode レンダラーのレジストリを通して描画する Plugin です。

導入

bash
npm install @riebeckite/plugin-shortcodes

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

使用例

バッジやキー表示、ノート、埋め込みなどの組み込み shortcode を使うか、独自のレンダラーを登録します。: ひとつはインライン、:: はブロック、::: はブロックコンテナとして描画されます。

markdown
ステータスは :badge[Stable]{variant=success}、ショートカットは :kbd[Ctrl+K] です。
 
ブロックでは次のように書きます。
 
::badge[Stable]{variant=success}
 
:::note[Heads up]{type=warning}
本文には **Markdown** を書けます。
:::

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Shortcodes
2 +
3 + `:name`（インライン）、`::name`（ブロック）、`:::name`（ブロックコンテナ）ディレクティブを、shortcode レンダラーのレジストリを通して描画する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-shortcodes
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + バッジやキー表示、ノート、埋め込みなどの組み込み shortcode を使うか、独自のレンダラーを登録します。`:` ひとつはインライン、`::` はブロック、`:::` はブロックコンテナとして描画されます。
16 +
17 + ```markdown
18 + ステータスは :badge[Stable]{variant=success}、ショートカットは :kbd[Ctrl+K] です。
19 +
20 + ブロックでは次のように書きます。
21 +
22 + ::badge[Stable]{variant=success}
23 +
24 + :::note[Heads up]{type=warning}
25 + 本文には **Markdown** を書けます。
26 + :::
27 + ```
28 +
29 + ## 使いどころ
30 +
31 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
32 +
33 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.ja.md) でも確認できます。
34 +
35 + ## 詳細仕様
36 +
37 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.ja.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.ja.md) を参照してください。
38 +