Color mode

Code Tabs

複数のコードブロックをタブとしてまとめて表示する Plugin です。

導入

bash
npm install @riebeckite/plugin-code-tabs

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

使用例

同じ処理を複数の言語やパッケージマネージャーで示すドキュメントに向いています。たとえば npm / pnpm / bun のコマンドを切り替えて提示できます。

ソース

markdown
```ts tab="React"
const greeting = "Hello from React";
```
 
```js tab="Vanilla"
console.log("Hello from JavaScript");
```

実行例

ts
const greeting = "Hello from React";
js
console.log("Hello from JavaScript");

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Code Tabs
2 +
3 + 複数のコードブロックをタブとしてまとめて表示する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-code-tabs
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + 同じ処理を複数の言語やパッケージマネージャーで示すドキュメントに向いています。たとえば `npm` / `pnpm` / `bun` のコマンドを切り替えて提示できます。
16 +
17 + ### ソース
18 +
19 + ````markdown
20 + ```ts tab="React"
21 + const greeting = "Hello from React";
22 + ```
23 +
24 + ```js tab="Vanilla"
25 + console.log("Hello from JavaScript");
26 + ```
27 + ````
28 +
29 + ### 実行例
30 +
31 + ```ts tab="React"
32 + const greeting = "Hello from React";
33 + ```
34 +
35 + ```js tab="Vanilla"
36 + console.log("Hello from JavaScript");
37 + ```
38 +
39 + ## 使いどころ
40 +
41 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
42 +
43 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.md) でも確認できます。
44 +
45 + ## 詳細仕様
46 +
47 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.md) を参照してください。
48 +
49 +