Color mode

Code Enhance

コードブロックに行番号、ファイル名、行ハイライト、コピー操作などの表示機能を追加する Plugin です。

導入

bash
npm install @riebeckite/plugin-code-enhance

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

使用例

コードブロックの可読性を高めたい技術記事で利用します。通常の fenced code block を書き、Plugin 側で表示を強化します。

ソース

markdown
```ts title="hello.ts"
const message = "Hello, Riebeckite";
console.log(message);
```

実行例

hello.ts
const message = "Hello, Riebeckite";
console.log(message);

使いどころ

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

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

詳細仕様

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

History

1 changesCollapseExpand
1 + # Code Enhance
2 +
3 + コードブロックに行番号、ファイル名、行ハイライト、コピー操作などの表示機能を追加する Plugin です。
4 +
5 + ## 導入
6 +
7 + ```bash
8 + npm install @riebeckite/plugin-code-enhance
9 + ```
10 +
11 + Plugin の export 名や設定項目は、実装と package README を一次情報として確認してください。Riebeckite の Plugin は `riebeckite.config.ts` の `plugins` に登録して利用します。
12 +
13 + ## 使用例
14 +
15 + コードブロックの可読性を高めたい技術記事で利用します。通常の fenced code block を書き、Plugin 側で表示を強化します。
16 +
17 + ### ソース
18 +
19 + ````markdown
20 + ```ts title="hello.ts"
21 + const message = "Hello, Riebeckite";
22 + console.log(message);
23 + ```
24 + ````
25 +
26 + ### 実行例
27 +
28 + ```ts title="hello.ts"
29 + const message = "Hello, Riebeckite";
30 + console.log(message);
31 + ```
32 +
33 + ## 使いどころ
34 +
35 + この Plugin が必要な場合だけ追加してください。Preset に含まれている場合は、同じ Plugin を重複して登録する必要はありません。
36 +
37 + 実際の表示例が用意されている場合は、[Plugin Showcase](./showcase.md) でも確認できます。
38 +
39 + ## 詳細仕様
40 +
41 + 設定項目、公開 API、制約、追加の使用例は package README を参照してください。Plugin 全体の仕組みは [Plugin System](../framework/plugin-system.md)、Plugin を作る場合は [Writing a Plugin](./writing-a-plugin.md) を参照してください。
42 +
43 +