Huskui.Avalonia.Markdown 1.2.0

Huskui.Avalonia.Markdown

A Markdown rendering extension for Huskui.Avalonia that converts Markdown text into native Avalonia control trees using Markdig.

Relationship to Huskui.Avalonia

Huskui.Avalonia.Markdown is an extension library for Huskui.Avalonia — it cannot be used standalone.

• Prerequisite: You must install Huskui.Avalonia and use HuskuiTheme in your application
• Auto-loading: Once the assembly is loaded, HuskuiTheme automatically merges the extension's theme resources via the [HuskuiExtension] mechanism — no manual style includes needed
• Shared namespace: Controls are mapped to https://github.com/d3ara1n/Huskui.Avalonia, using the same husk: XAML prefix as the core library

Installation

dotnet add package Huskui.Avalonia
dotnet add package Huskui.Avalonia.Markdown

Usage

Basic

<husk:MarkdownViewer Markdown="{Binding MarkdownText}" />

Properties

XAML Example

<UserControl xmlns="https://github.com/avaloniaui"
             xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
             xmlns:husk="https://github.com/d3ara1n/Huskui.Avalonia"
             x:Class="YourApp.MarkdownPage">
    <husk:MarkdownViewer
        Spacing="8"
        Markdown="# Hello World&#x0a;&#x0a;This is **bold** and *italic* text.&#x0a;&#x0a;- Item 1&#x0a;- Item 2&#x0a;&#x0a;```csharp&#x0a;Console.WriteLine(&quot;Hello&quot;);&#x0a;```" />
</UserControl>

C# Example

var viewer = new MarkdownViewer();
viewer.Markdown = """
    # Hello World

    This is **bold** and *italic* text.

    - Item 1
    - Item 2

    ```csharp
    Console.WriteLine("Hello");
    ```
    """;

Styling

MarkdownViewer generates bare controls with semantic CSS classes but no built-in visual styles. The extension ships a default theme bundle that is auto-loaded by HuskuiTheme, but you can override or extend styles by targeting the generated class names.

The class naming convention is Control.Markdown.Variant. Here are some examples:

Custom Style Example

<Styles>
    
    <Style Selector="TextBlock.Markdown.Heading1">
        <Setter Property="FontWeight" Value="Bold" />
        <Setter Property="FontSize" Value="28" />
    </Style>

    
    <Style Selector="husk|InfoBar.Markdown.Quote">
        <Setter Property="BorderBrush" Value="Blue" />
        <Setter Property="BorderThickness" Value="3,0,0,0" />
        <Setter Property="Padding" Value="12,8" />
    </Style>

    
    <Style Selector="husk|CodeViewer.Markdown.Code">
        <Setter Property="Background" Value="#1e1e1e" />
        <Setter Property="Foreground" Value="#d4d4d4" />
    </Style>

    
    <Style Selector="DockPanel.Markdown.List.Item">
        <Setter Property="Margin" Value="16,0,0,0" />
    </Style>
</Styles>

Markdown Support

Supported

Not Yet Supported

Dependencies

• Huskui.Avalonia — Core control library
• Huskui.Avalonia.Code — Code block rendering (CodeViewer)
• Markdig — Markdown parsing
• AsyncImageLoader.Avalonia — Async image loading

License

MIT