syncfusion-dotnet-markdown

Markdown ドキュメントの処理

概要

Syncfusion Markdown Library を使用して、Markdown（.md）ファイルを作成、編集、変換します。 このスキルでは、ユーザーのプロジェクト用の C# コードを生成する方法と、CSX スクリプトを使ってタスクを直接実行する方法の 2 つの運用モードをサポートしています。

主な機能

• 作成と編集： 段落、見出し、リスト、表、画像、ハイパーリンク、コードブロック、引用、タスクリスト
• 解析と変更： ファイル／ストリームから読み込み、ブロックやインライン要素を反復処理して更新
• シリアル化： Markdown ドキュメントモデルをプレーンな Markdown テキストに変換し、ファイルに書き込み
• 高度な機能： カスタム解析イベント、画像読み込みハンドラー、ネストされたリスト、タスクリストのサポート

前提条件

• .NET SDK 8+ と dotnet-script：dotnet tool install -g dotnet-script
• Syncfusion ライセンス：https://www.syncfusion.com/products/communitylicense

クイックスタートの例

例 1：コードを生成（モード 1）

ユーザー：「表を含む Markdown ドキュメントの作成方法を教えてください」

結果： C# コードスニペットを表示（ファイルは作成されません）

例 2：タスクを実行（モード 2）

ユーザー：「output/report.md に Markdown ファイルを作成してください」

結果： 指定したパスにファイルを作成

2 つのモード — ユーザーの意図に応じて選択

モードを選択する前に、ユーザーが何を実現したいのかを推測してください。

モード 1：ユーザーのプロジェクト用に C# コードを生成 (デフォルト)

Markdown の処理に関連する C# コードを表示、記述、レビュー、リファクタリング、変更したい場合は、このモードを使用します。

トリガーキーワード： "show me how", "how to", "how can I", "how do I", "provide code", "provide an example", "give an example", "demonstrate", "code snippet", "sample code", "example", "sample", "give me", "show me", "Program.cs", "example code", "generate code for", "codesnippet"

ワークフロー：

ステップ 1 — アプリケーションの種類を特定し、適切な NuGet パッケージを提案する

• ワークスペースのプロジェクトファイル（.csproj、web.config、App.config、Startup.cs、Program.cs など）を調べ、references/nuget-packages.md の検出シグナル表を使用してアプリケーションの種類を特定します。
• 特定したアプリケーションの種類に基づいて、references/nuget-packages.md から適切なパッケージを確認し、コードを生成する前にインストールするようユーザーに伝えます。

ステップ 2 — 参照ファイルのみを使用してコードを生成する

参照ファイルに明記されていない API、メソッド、プロパティ、クラス、名前空間を、創作、推測、提案してはいけません。

• 要求された機能に関連する references/*.md ファイルを読み込みます
• それらのファイルに記載された API とスニペットのみを使用して C# コードを作成します
• ステップ 1 で特定したアプリケーションの種類に応じて、適切なスニペットのバリエーションを選択します：
  • Windows 固有のアプリ（WinForms、WPF、.NET Framework Console、ASP.NET MVC5）→ Windows 固有のスニペットを使用
  • クロスプラットフォームアプリ（ASP.NET Core、.NET Core/.NET 5+ Console、Blazor、MAUI）→ クロスプラットフォーム／.Net.Core スニペットを使用
• .csx スクリプトを作成または実行しないでください

---

モード 2：CSX スクリプトで実行 (プロジェクトファイルは変更しません)

ユーザーが実行、ファイル生成、または完成した md ファイルなど、完全に作成された出力を明示的に要求した場合にのみ、このモードを使用します。

トリガーキーワード： "create a markdown document", "make a markdown file", "generate markdown", "parse markdown", "convert markdown to HTML", "open", "edit", "modify", "change" a .md file, "without modifying my project", "run a csx script"、またはユーザーがファイルパス（例：output/report.md）を指定した場合

ワークフロー：

ステップ 1 — 一時 CSX スクリプトを作成する

• references/template.csx をベースとして使用します
• {skill-root}/syncfusion-dotnet-markdown/scripts/temp-{uniqueId}.csx に作成します（例：skill-root = .codestudio/skills）
• ファイル名にはランダムな GUID を使用します（例：temp-a3f7b2c1.csx）。ワークスペースのルートには作成しないでください

ステップ 2 — 参照ファイルを基にスクリプトを作成する

• 参照ファイルにない API／メソッドを作らないでください
• 関連する references/*.md ファイルを読み、コードスニペットを抽出します
• すべてのプレースホルダー（ファイルパス、ドキュメントのプロパティ、データ値、フィールド名など）を置き換えます

ステップ 3 — スクリプトを実行する

• 実行：dotnet script {skill-root}/syncfusion-dotnet-markdown/scripts/temp-{uniqueId}.csx
• 実行が成功したことを確認し、エラーがあれば記録します

ステップ 4 — クリーンアップして報告する

• 実行後に一時 .csx ファイルを削除します
• 成功／エラーの結果、出力ファイルのパス、およびエラーメッセージと修正内容を報告します

---

コードリファレンス

テンプレートとスニペットはすべて references/ フォルダーにあります：

ファイル	内容
template.csx	基本的な CSX スクリプト構造（モード 2 のみ）
document-structure.md	Markdown ドキュメントの作成／読み込み／保存、DOM 構造、ブロック要素とインライン要素
create-markdown.md	Markdown ドキュメントの新規作成、段落、見出し、書式の追加
parse-markdown.md	ファイル／ストリームからの Markdown の解析、ブロックの処理、コンテンツの反復処理、解析済みドキュメントの変更
text-formatting.md	太字、斜体、取り消し線、コードスパン、下付き文字、上付き文字の書式設定
headings-styles.md	見出しスタイル（H1～H6）、段落スタイル、引用ブロックの適用
lists.md	番号付きリストと箇条書きリスト、入れ子のリスト（最大 8 レベル）、リストの書式設定
tables.md	列揃え（左、中央、右）を指定した表の作成、行とセルの追加
hyperlinks.md	表示テキスト、URL、スクリーンヒントを含むハイパーリンクの追加
images.md	URL またはバイト列からの画像の挿入、代替テキスト、画像形式、Base64 エンコード
code-blocks.md	フェンス付きおよびインデント形式のコードブロックの作成、言語の指定
blockquotes.md	入れ子レベルを指定した引用ブロックの作成
task-lists.md	チェック済み／未チェックのチェックボックスを含むタスクリストの作成（GitHub 形式）
advanced-features.md	高度な Markdown 機能、カスタム解析、イベント

ルール

• 出力ファイルは ./output/ ディレクトリに保存します
• 一時 .csx スクリプトは {skill-root}/syncfusion-dotnet-markdown/scripts/ 内に作成する必要があります。ワークスペースのルートや顧客の scripts/ フォルダーには作成しないでください
• Python ライブラリ（例：python-markdown）は使用しないでください
• 実行後に一時 .csx ファイルを残さないでください