LiveMarkdown 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package LiveMarkdown --version 1.0.0
                    
NuGet\Install-Package LiveMarkdown -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="LiveMarkdown" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="LiveMarkdown" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="LiveMarkdown" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add LiveMarkdown --version 1.0.0
                    
#r "nuget: LiveMarkdown, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package LiveMarkdown@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=LiveMarkdown&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=LiveMarkdown&version=1.0.0
                    
Install as a Cake Tool

LiveMarkdown

LiveMarkdown is a lightweight Avalonia-based Markdown renderer and viewer for .NET 8. It focuses on producing a high-quality visual representation of Markdown documents (headings, lists, tables, code fences, inline and block LaTeX, task lists, quotes, horizontal rules and more) and includes features for incremental/stream rendering to support live preview scenarios.

Key features

  • Full Markdown support via Markdig with advanced extensions enabled
  • Inline and block math rendering using AvaloniaMath (LaTeX support)
  • Syntax-highlighted fenced code blocks using AvaloniaEdit
  • Tables, task lists, emojis, and more
  • Incremental/stream rendering mode: the renderer is optimized to re-render only appended changes at the document end when used in streaming/live-edit scenarios, making it ideal for live preview while writing or piping content progressively
  • Rich styling via Generic.axaml styles and CSS-like classes on visual elements

Dependencies

  • .NET 8 (net8.0)
  • Avalonia 11.3.9
  • Avalonia.AvaloniaEdit 11.3.0
  • AvaloniaMath 2.1.0
  • Markdig 0.44.0

See LiveMarkdown/LiveMarkdown.csproj for exact package versions used in the project.

Build & run

  1. Install .NET 8 SDK: https://dotnet.microsoft.com/download
  2. Clone the repository
  3. Restore and build:
    • dotnet restore
    • dotnet build
  4. Run the application from the project folder:
    • dotnet run --project LiveMarkdown/LiveMarkdown.csproj

Notes about streaming and live preview The renderer implements an incremental rendering mode that detects when the new input is a simple append to the previous content and attempts to update only the end of the visual tree. This reduces CPU and UI churn during typical live-edit workflows (typing or appending text) and makes the viewer suitable for streaming scenarios where Markdown arrives progressively.

Contributing Contributions are welcome. Please open issues or pull requests. When contributing, try to keep changes small and focused and follow the existing code style.

License This project is provided under the MIT License. See LICENSE for details.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.2 118 12/29/2025
1.1.1 97 12/28/2025
1.1.0 282 12/15/2025
1.0.0 420 12/8/2025