ProMarkdown 0.1.1

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package ProMarkdown --version 0.1.1
                    


                    

                
NuGet\Install-Package ProMarkdown -Version 0.1.1
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="ProMarkdown" Version="0.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ProMarkdown" Version="0.1.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ProMarkdown" />
                    


                            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 ProMarkdown --version 0.1.1
                    


                    

                
#r "nuget: ProMarkdown, 0.1.1"
#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 ProMarkdown@0.1.1
#: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=ProMarkdown&version=0.1.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ProMarkdown&version=0.1.1
                    


                            Install as a Cake Tool

ProMarkdown

Reusable Avalonia markdown rendering and editing libraries built on Markdig.

Highlights

  • Avalonia control and service layer for rendering Markdown documents.
  • Source-aware editing, selection, hit testing, and URI handling.
  • Optional plugin packages for alerts, custom containers, definition lists, figures, footers, math, Mermaid diagrams, syntax highlighting, and TextMate integration.
  • Standalone sample application that composes the complete Markdown stack.
  • Headless rendering and Mermaid test coverage.

Projects

Project Responsibility
src/ProMarkdown Core controls, parsing, rendering, editing, layout, selection, and theme services.
src/ProMarkdown.Plugin.Alerts Alert block parsing, rendering, and editing.
src/ProMarkdown.Plugin.CustomContainers Generic custom-container support.
src/ProMarkdown.Plugin.DefinitionLists Definition-list parsing, rendering, and editing.
src/ProMarkdown.Plugin.Figures Figure and caption support.
src/ProMarkdown.Plugin.Footers Footer metadata blocks.
src/ProMarkdown.Plugin.Math Inline and block math support.
src/ProMarkdown.Plugin.Mermaid Mermaid diagram rendering.
src/ProMarkdown.Plugin.SyntaxHighlighting Built-in code syntax highlighting.
src/ProMarkdown.Plugin.TextMate TextMate-backed highlighting and editor integration.
src/ProMarkdown.Sample Desktop sample that composes the library and plugins.
tests/ProMarkdown.Tests Headless rendering and Mermaid tests.

NuGet packages

Package Version Downloads Description
ProMarkdown NuGet Version NuGet Downloads Core Avalonia Markdown rendering and editing primitives.
ProMarkdown.Plugin.Alerts NuGet Version NuGet Downloads Alert block parsing, rendering, and editing.
ProMarkdown.Plugin.CustomContainers NuGet Version NuGet Downloads Custom-container parsing, rendering, and editing.
ProMarkdown.Plugin.DefinitionLists NuGet Version NuGet Downloads Definition-list parsing, rendering, and editing.
ProMarkdown.Plugin.Figures NuGet Version NuGet Downloads Figure block parsing, rendering, and editing.
ProMarkdown.Plugin.Footers NuGet Version NuGet Downloads Footer block parsing, rendering, and editing.
ProMarkdown.Plugin.Math NuGet Version NuGet Downloads Inline and block math parsing, rendering, and editing.
ProMarkdown.Plugin.Mermaid NuGet Version NuGet Downloads Mermaid diagram rendering.
ProMarkdown.Plugin.SyntaxHighlighting NuGet Version NuGet Downloads Built-in syntax highlighting for code blocks.
ProMarkdown.Plugin.TextMate NuGet Version NuGet Downloads TextMate-backed highlighting and editor integration.

Prerequisites

  • .NET 10 SDK

Build and test

dotnet restore ProMarkdown.slnx
dotnet build ProMarkdown.slnx
dotnet test --solution ProMarkdown.slnx

Run the sample

dotnet run --project src/ProMarkdown.Sample/ProMarkdown.Sample.csproj

The sample provides an editor and preview surface with the plugin ecosystem registered together.

Documentation

The published documentation is available at wieslawsoltes.github.io/ProMarkdown. The Lunet source lives under site/.

dotnet tool restore
bash ./check-docs.sh

To serve it locally:

bash ./serve-docs.sh

PowerShell equivalents are included for the build, check, and serve commands. Detailed Markdown implementation notes live under docs/.

CI and releases

  • .github/workflows/build.yml builds, tests, validates docs, and packs the Markdown projects.
  • .github/workflows/docs.yml publishes the Lunet site.
  • .github/workflows/release.yml validates and publishes the ProMarkdown NuGet packages for tagged releases.

License

MIT. See LICENSE.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  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 (9)

Showing the top 5 NuGet packages that depend on ProMarkdown:

Package Downloads
ProMarkdown.Plugin.Math

Math block and inline parsing, rendering, and editing support for ProMarkdown.
ProMarkdown.Plugin.Mermaid

Mermaid diagram rendering support for ProMarkdown.
ProMarkdown.Plugin.CustomContainers

Custom container parsing, rendering, and editing support for ProMarkdown.
ProMarkdown.Plugin.Figures

Figure block parsing, rendering, and editing support for ProMarkdown.
ProMarkdown.Plugin.SyntaxHighlighting

Built-in syntax highlighting support for ProMarkdown code blocks.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.1 163 8/19/2026
0.1.0 154 8/17/2026