syncfusion/wpf-ui-components-skills / skills/syncfusion-wpf-markdown-viewer
syncfusion-wpf-markdown-viewer
VerifiedImplement Syncfusion WPF SfMarkdownViewer for rendering and displaying Markdown content in WPF applications. Use this when rendering Markdown text, loading Markdown from strings or application-controlled local files, handling hyperlink clicks with URL validation, or displaying Mermaid diagrams with input sanitization. Covers the Source property, HyperlinkClicked events with allowlist-based navigation, and MermaidBlockTemplate customization with input validation. Always validate and sanitize Markdown content before assigning to Source, especially when the content originates from remote or user-supplied sources.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 6.1 KB |
| references/events.md | markdown | 4.7 KB |
| references/getting-started.md | markdown | 3.2 KB |
| references/loading-content.md | markdown | 6.5 KB |
| references/mermaid-diagrams.md | markdown | 6.7 KB |
references/getting-started.md
View on GitHub# Getting Started
## Installation
Install the NuGet package in your WPF project:
```
Syncfusion.SfMarkdownViewer.Wpf
```
Or add assembly references manually:
- `Syncfusion.SfMarkdownViewer.WPF`
- `Syncfusion.Markdown`
- `Syncfusion.Shared.WPF`
> **Note:** Unlike most other Syncfusion WPF controls, `SfMarkdownViewer` requires **three** assembly references. `Syncfusion.Markdown` handles the parsing and `Syncfusion.Shared.WPF` provides shared infrastructure.
## XAML Namespace
Import the Markdown namespace in your XAML page:
```xaml
xmlns:markdown="clr-namespace:Syncfusion.UI.Xaml.Markdown;assembly=Syncfusion.SfMarkdownViewer.WPF"
```
## Adding via XAML
```xaml
<Window
x:Class="GettingStarted.MainWindow"
xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
xmlns:markdown="clr-namespace:Syncfusion.UI.Xaml.Markdown;assembly=Syncfusion.SfMarkdownViewer.WPF"
xmlns:system="clr-namespace:System;assembly=mscorlib">
<Grid>
<markdown:SfMarkdownViewer />
</Grid>
</Window>
```
## Adding via C#
```csharp
using Syncfusion.UI.Xaml.Markdown;
namespace MarkdownViewerGettingStarted
{
public partial class MainWindow : Window
{
public MainWindow()
{
InitializeComponent();
SfMarkdownViewer markdownViewer = new SfMarkdownViewer();
this.Content = markdownViewer;
}
}
}
```
## Setting Inline Markdown Content
Use the `Source` property with a CDATA string in XAML for multi-line inline Markdown:
```xaml
<markdown:SfMarkdownViewer>
<markdown:SfMarkdownViewer.Source>
<system:String xml:space="preserve">
<
]]>
</system:String>
</markdown:SfMarkdownViewer.Source>
</markdown:SfMarkdownViewer>
```
In code-behind, assign a multiline string directly:
```csharp
private const string markdownContent = @"
# What is the Markdown Viewer?
The MarkdownViewer control renders Markdown files into a clean, readable format.
## Features
- Headings, lists, links, images
- Code blocks and tables
- Block quotes";
public MainWindow()
{
InitializeComponent();
SfMarkdownViewer markdownViewer = new SfMarkdownViewer();
markdownViewer.Source = markdownContent;
this.Content = markdownViewer;
}
```
## Gotchas
- **Three assemblies required** — unlike most Syncfusion WPF controls that use a single assembly, `SfMarkdownViewer` needs `Syncfusion.SfMarkdownViewer.WPF`, `Syncfusion.Markdown`, and `Syncfusion.Shared.WPF`
- **`xml:space="preserve"` is required** for CDATA inline strings in XAML — without it, whitespace and newlines are collapsed
- **`Source` is a string property** — it accepts raw Markdown text, a file path, or a URL; the control auto-detects which one to use (see loading-content.md)
- **No separate `Text` property** — always use `Source` to provide content; there is no separate binding for Markdown text vs file path
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |