OfficeIMO.MarkdownRenderer.Wpf 0.1.28

OfficeIMO.MarkdownRenderer.Wpf - WPF MarkdownView host

👁 nuget version
👁 nuget downloads

OfficeIMO.MarkdownRenderer.Wpf provides a reusable WPF MarkdownView control built on WebView2 and OfficeIMO.MarkdownRenderer.

Install

dotnet add package OfficeIMO.MarkdownRenderer.Wpf

Requirements

• Windows desktop application using WPF.
• WebView2 runtime available on the target machine.
• OfficeIMO.MarkdownRenderer.Wpf and its OfficeIMO.MarkdownRenderer dependency.

If target machines may not already have WebView2 installed, ship or bootstrap the Evergreen WebView2 Runtime as part of your installer strategy.

Quick start

<Window
 xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
 xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
 xmlns:omd="clr-namespace:OfficeIMO.MarkdownRenderer.Wpf;assembly=OfficeIMO.MarkdownRenderer.Wpf">
 <Grid>
 <omd:MarkdownView x:Name="Preview"
 Preset="Relaxed"
 DocumentTitle="README" />
 </Grid>
</Window>

Preview.Markdown = """
# Hello

This content is rendered by OfficeIMO.MarkdownRenderer.Wpf.
""";

Preview.ConfigureRendererOptions = options =>
{
 options.EnableCodeCopyButtons = true;
 options.EnableTableCopyButtons = true;
};

Examples

Handle external navigation

using System.Diagnostics;

Preview.NavigationRequested += (_, args) =>
{
 Process.Start(new ProcessStartInfo(args.Uri.AbsoluteUri) {
 UseShellExecute = true
 });
 args.Handled = true;
};

Use pre-rendered body HTML

using OfficeIMO.MarkdownRenderer;

var options = MarkdownRendererPresets.CreateStrict();
Preview.BodyHtml = MarkdownRenderer.RenderBodyHtml(markdownText, options);
Preview.Markdown = string.Empty;

What it does

• Hosts the OfficeIMO Markdown shell in a WPF/WebView2 control.
• Lets host apps choose presets, CSS overrides, renderer options, and link handling.
• Supports clipboard copy messages from shell actions.
• Allows advanced hosts to set pre-rendered BodyHtml instead of Markdown.
• Implements IDisposable so long-lived hosts can release WebView2 resources explicitly.

Boundaries

• This package owns the WPF control surface.
• Generic rendering behavior belongs in OfficeIMO.MarkdownRenderer.
• Application-specific navigation, telemetry, fallback UI, and installer/runtime policy stay in the host app.

Targets and license

• Targets: Windows WPF/WebView2 package targets.
• License: MIT.
• Repository: EvotecIT/OfficeIMO