Vrmac.Markdown 1.0.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package Vrmac.Markdown --version 1.0.0
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Vrmac.Markdown" />
                    


                            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 Vrmac.Markdown --version 1.0.0
                    


                    

                
#r "nuget: Vrmac.Markdown, 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 Vrmac.Markdown@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=Vrmac.Markdown&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Vrmac.Markdown&version=1.0.0
                    


                            Install as a Cake Tool

Vrmac.Markdown

This library contains functions to render markdown into HTML.

Specifically, it implements two alternative methods of doing so.

MarkdownRender

MarkdownRender static class implements a fast but limited markdown renderer.

That class only supports the following features:

  • Paragraphs and 3 levels of headers.
  • Bold, italic, inline code blocks.
  • Hyperlinks.

Not even lists are supported.

MarkdownStandard

MarkdownStandard static class is based on Markdig.Signed third-party library, and implements a fully featured, standard-compliant markdown renderer. It uses more resources to render, particularly in terms of memory allocations.

Placeholders extension

This renderer implements a custom extension.

To enable the extension, implement the iMarkdownPlaceholders interface defined by this library in the consuming project:

/// <summary>Callback interface to inject custom blocks into the markdown</summary>
public interface iMarkdownPlaceholders
{
	/// <summary>Write content of the custom block</summary>
	void write( StreamWriter w, string id );
}

And pass your object to the iMarkdownPlaceholders? placeholders argument of the render function.

When the extension is enabled, the markdown parser tests lines in the source text against the following regular expression:

^\s*@([a-zA-Z][a-zA-Z0-9]*)\s*$

When a line matches, the renderer extracts the captured group. Instead of interpreting the line as markdown, it calls the iMarkdownPlaceholders.write callback method, passing the captured group’s value.

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

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.0.0 72 9/30/2026