mcpField
S
syncfusion-dotnet-markdown

syncfusion-dotnet-markdown

github.com/syncfusion文档处理295 次安装1 周前更新
代码仓库

关于 syncfusion-dotnet-markdown

syncfusion-dotnet-markdown 是使用 Syncfusion Markdown Library 创建、解析、编辑和转换 Markdown 的 skill。它既可为项目生成 C# 示例，也可运行 CSX 脚本生成或修改文件。

主要功能

  1. 01创建和编辑 Markdown 文档
  2. 02解析并修改文档块与行内元素
  3. 03将文档模型序列化为 Markdown 文本
  4. 04生成 C# 代码或运行 CSX 任务
  5. 05处理表格、图像、列表和格式

适用场景

  1. 01生成 Markdown 操作的 C# 示例
  2. 02在指定路径创建 Markdown 文件
  3. 03解析并更新现有 Markdown 内容

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/syncfusion/document-sdk-skills --skill syncfusion-dotnet-markdown

安装后在 Claude Code 中输入/syncfusion-dotnet-markdown确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

README.md
references/
advanced-features.md
blockquotes.md
code-blocks.md
create-markdown.md
document-structure.md
headings-styles.md
hyperlinks.md
images.md
lists.md
nuget-packages.md
parse-markdown.md
tables.md
task-lists.md
template.csx
text-formatting.md
scripts/
.gitkeep

详细介绍

Markdown 文档处理

概述

使用 Syncfusion Markdown Library 创建、编辑和转换 Markdown（.md）文件。 此技能支持两种操作模式——为用户的项目生成 C# 代码，或直接通过 CSX 脚本执行任务。

主要功能

  • 创建和编辑： 段落、标题、列表、表格、图像、超链接、代码块、引用块、任务列表
  • 解析和修改： 从文件/流中加载，遍历并更新块和行内内容
  • 序列化： 将 Markdown 文档模型转换回纯 Markdown 文本并写入文件
  • 高级功能： 自定义解析事件、图像加载处理程序、嵌套列表、任务列表支持

先决条件

快速入门示例

示例 1：生成代码（模式 1）

用户：“演示如何创建包含表格的 Markdown 文档”

结果： 显示 C# 代码片段（不创建文件）

示例 2：执行任务（模式 2）

用户：“在 output/report.md 创建一个 Markdown 文件”

结果： 在指定路径创建实际文件

两种模式——根据用户意图选择

选择模式之前，先推断用户想要完成什么：

模式 1：为用户的项目生成 C# 代码*（默认）*

当用户想要查看、编写、审查、重构或修改与 Markdown 处理相关的 C# 代码时，使用此模式。

触发关键词：“演示一下”、“如何”、“如何才能”、“我该如何”、“提供代码”、“提供示例”、“举个例子”、“演示”、“代码片段”、“示例代码”、“示例”、“样例”、“给我”、“给我看看”、“Program.cs”、“示例代码”、“为……生成代码”、“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 文件）时，使用此模式。

触发关键词：“创建 Markdown 文档”、“制作 Markdown 文件”、“生成 Markdown”、“解析 Markdown”、“将 Markdown 转换为 HTML”、“打开”、“编辑”、“修改”、“更改” .md 文件、“不修改我的项目”、“运行 csx 脚本”，或者用户提供了文件路径（例如 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 文件
  • 报告 SUCCESS/ERROR，并提供输出文件路径和任何错误消息及修复方法

代码参考

所有模板和代码片段都在 references/ 文件夹中：

文件内容
template.csxCSX 脚本基本结构（仅限模式 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 文件

评论

支持 Markdown