关于 syncfusion-maui-markdown-viewer
该技能指导在 .NET MAUI 应用中使用 Syncfusion SfMarkdownViewer 渲染 Markdown,适合需要展示文档、帮助内容或更新说明的开发者。它支持多种内容来源,并提供样式定制及文本提取和转换方法。
主要功能
- 01渲染标题、列表、表格和代码块
- 02从字符串、文件或 URL 加载内容
- 03定制字体、颜色与间距
- 04使用 CSS 设置内容样式
- 05提取 Markdown、HTML 或纯文本
适用场景
- 01在应用内展示文档和帮助内容
- 02呈现版本更新说明与常见问题
- 03从远程 URL 加载 Markdown 内容
- 04将 Markdown 转换为 HTML 或纯文本
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ syncfusion/ maui-ui-components-skills --skill syncfusion-maui-markdown-viewer安装后在 Claude Code 中输入/syncfusion-maui-markdown-viewer确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/appearance-customization.mdcontent-retrieval.mdcustom-css-styling.mdgetting-started.mdloading-content.mdtroubleshooting.md详细介绍
实现 Syncfusion .NET MAUI MarkdownViewer
本技能将指导你实现 SfMarkdownViewer 控件。这是一款轻量高效的 UI 组件,可在 .NET MAUI 应用中跨移动端和桌面平台渲染 Markdown 内容,并全面支持格式设置。
何时使用此技能
在以下情况下使用此技能:
- 在 .NET MAUI 应用中显示 Markdown 格式的内容
- 渲染应用内文档、用户指南或帮助内容
- 显示发行说明、更新日志或功能更新
- 展示常见问题、故障排除指南或支持文章
- 从字符串、本地文件、嵌入式资源或 URL 加载 Markdown
- 自定义渲染后 Markdown 的外观(字体、颜色、间距)
- 应用自定义 CSS 样式,进行高级主题设置
- 以编程方式获取或转换 Markdown 内容(转换为 HTML 或纯文本)
- 创建文档查看器、笔记应用或内容门户
组件概览
SfMarkdownViewer 提供:
- 标准 Markdown 支持 — 渲染标题、粗体/斜体文本、列表、表格、图像、代码块、链接等
- 灵活的输入源 — 从字符串、
.md文件、嵌入式资源或远程 URL 加载内容 - 外观自定义 — 通过
MarkdownStyleSettings控制字体、颜色和间距 - 自定义 CSS 样式 — 使用原始 CSS 规则进行高级主题设置
- 内容获取 — 访问原始 Markdown、转换为 HTML 或提取纯文本
- 流畅滚动 — 在所有平台上流畅浏览大型文档
- 跨平台 — 在 iOS、Android、Windows 和 macOS 上保持一致的渲染效果
典型用例:
- 应用内文档和功能导览
- 发行说明和版本更新展示
- 帮助版块和支持门户
- 包含链接的交互式内容
- 带样式的内容展示
文档与导航指南
入门
📄 阅读: references/getting-started.md
在以下情况下阅读:
- 安装
Syncfusion.Maui.MarkdownViewerNuGet 包 - 在
MauiProgram.cs中注册 Syncfusion 处理程序 - 创建你的第一个 SfMarkdownViewer 控件(XAML 或 C#)
- 添加要显示的基本 Markdown 内容
从不同来源加载内容
📄 阅读: references/loading-content.md
在以下情况下阅读:
- 从字符串变量加载 Markdown
- 从本地
.md文件读取 Markdown - 从项目中加载嵌入式资源文件
- 从远程 URL 获取 Markdown
- 处理异步加载场景
- 为你的用例选择合适的内容源
外观自定义
📄 阅读: references/appearance-customization.md
在以下情况下阅读:
- 自定义标题字号和颜色(H1、H2、H3)
- 更改正文的字体大小和颜色
- 设置表头、数据单元格和背景的样式
- 使用
MarkdownStyleSettings类 - 使 Markdown 外观与应用主题保持一致
- 了解基于属性的样式设置方法
自定义 CSS 样式
📄 阅读: references/custom-css-styling.md
在以下情况下阅读:
- 应用超出基本属性范围的高级样式
- 使用自定义 CSS 规则覆盖默认样式
- 设置图像样式(边框、阴影、圆角、尺寸)
- 自定义表格外观(交替行、边框、内边距)
- 控制滚动条的可见性和样式
- 实现品牌化内容设计
- 了解 CSS 相对于属性的优先级
内容获取
📄 阅读: references/content-retrieval.md
在以下情况下阅读:
- 以编程方式获取原始 Markdown 文本
- 将 Markdown 内容转换为 HTML 格式
- 提取未格式化的纯文本
- 使用
GetMarkdownText()、GetHtmlText()或GetText()方法 - 在代码中处理或转换 Markdown 内容
故障排除
📄 阅读: references/troubleshooting.md
遇到以下问题时:
- 处理程序未注册错误
- NuGet 包安装问题
- 样式未正确应用
- CSS 无法覆盖属性
- 字体大小单位问题
- 图片加载失败
- URL 加载问题
- 跨平台渲染差异
评论
支持 Markdown