Skip to main content
.NETFramework4.6.1.NETCoreApp2.0net6.0.NETStandard2.0

Markdown Controls for Avalonia

Published
May 14, 2023
3y ago
Total Downloads
708.9K
708,913

Deprecated Package Version

Reason: Other

Syntax highlighting is disabled because the dependencies package has not been released yet.

Install

dotnet add package Markdown.Avalonia --version 11.0.0-b2
ProductVersions
.NET
net6.0
.NET Standard
netstandard2.0
Other
.NETCoreApp2.0.NETFramework4.6.1

README

Markdown.Avalonia render Markdown with avalonia ui. It transform markdown to controls (ex: Border, Grid, TextBlock).

This package depends on AvaloniaEdit for syntax highlighting. If you don't want it, use Markdown.Avalonia.Tight instead.

How to use

Markdown.Avalonia supports three methods to render markdown.

  1. Load .md from AvaloniaResource
    <md:MarkdownScrollViewer
       Source="avares://YourAssemblyName/Assets/Test.md"/>
    
  2. Write markdown in xaml
    <md:MarkdownScrollViewer>
      # Heading1
      Hello Markdown.Avalonia!
    </md:MarkdownScrollViewer>
    
  3. With binding
    <md:MarkdownScrollViewer
       Markdown="{Binding MdText}"/>
    

Preview
sc1
sc2

Changes from Previous Version

v11.0.0-b1v11.0.0-b2
Removed Dependencies
Deprecated
This version was marked as deprecated.

Adoption Assessment

Assess this package against its supported frameworks, license, maintenance signals and dependency graph before making it a project standard.

This version is marked prerelease. Validate its API and upgrade path before production use.NuGet marks this package as deprecated. Review the publisher's migration guidance before adopting it.Compatibility metadata lists 4 target frameworks; confirm the exact target used by your application.

Related Guides & Workflows

Learn how to evaluate, integrate, or audit this package in your .NET project.