Markdig 0.30.4

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET 6.0 .NET Core 3.1 .NET Standard 2.0 .NET Framework 4.5.2
dotnet add package Markdig --version 0.30.4
NuGet\Install-Package Markdig -Version 0.30.4
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="Markdig" Version="0.30.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Markdig --version 0.30.4
#r "nuget: Markdig, 0.30.4"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Markdig as a Cake Addin
#addin nuget:?package=Markdig&version=0.30.4

// Install Markdig as a Cake Tool
#tool nuget:?package=Markdig&version=0.30.4

Markdig Build Status Coverage Status NuGet Donate

<img align="right" width="160px" height="160px" src="img/markdig.png">

Markdig is a fast, powerful, CommonMark compliant, extensible Markdown processor for .NET.

NOTE: The repository is under construction. There will be a dedicated website and proper documentation at some point!

You can try Markdig online and compare it to other implementations on babelmark3

Features

If you are looking for support for an old .NET Framework 3.5 or 4.0, you can download Markdig 0.18.3.

Third Party Extensions

Documentation

The repository is under construction. There will be a dedicated website and proper documentation at some point!

While there is not yet a dedicated documentation, you can find from the specs documentation how to use these extensions.

In the meantime, you can have a "behind the scene" article about Markdig in my blog post "Implementing a Markdown Engine for .NET"

Download

Markdig is available as a NuGet package: NuGet

Also Markdig.Signed NuGet package provides signed assemblies.

Usage

The main entry point for the API is the Markdig.Markdown class:

By default, without any options, Markdig is using the plain CommonMark parser:

var result = Markdown.ToHtml("This is a text with some *emphasis*");
Console.WriteLine(result);   // prints: <p>This is a text with some <em>emphasis</em></p>

In order to activate most of all advanced extensions (except Emoji, SoftLine as HardLine, Bootstrap, YAML Front Matter, JiraLinks and SmartyPants)

// Configure the pipeline with all advanced extensions active
var pipeline = new MarkdownPipelineBuilder().UseAdvancedExtensions().Build();
var result = Markdown.ToHtml("This is a text with some *emphasis*", pipeline);

Try it online!

You can have a look at the MarkdownExtensions that describes all actionable extensions (by modifying the MarkdownPipeline)

Build

In order to build Markdig, you need to install .NET 6.0

License

This software is released under the BSD-Clause 2 license.

Benchmarking

The latest benchmark was collected on April 23 2022, against the following implementations:

  • Markdig (version: 0.30.2): itself
  • cmark (version: 0.30.2): Reference C implementation of CommonMark, no support for extensions
  • CommonMark.NET(master) (version: 0.15.1): CommonMark implementation for .NET, no support for extensions, port of cmark, deprecated.
  • MarkdownSharp (version: 2.0.5): Open source C# implementation of Markdown processor, as featured previously on Stack Overflow, regexp based.
// * Summary *

BenchmarkDotNet=v0.13.1, OS=Windows 10.0.22000
AMD Ryzen 9 5950X, 1 CPU, 32 logical and 16 physical cores
.NET SDK=6.0.202
  [Host]     : .NET 6.0.4 (6.0.422.16404), X64 RyuJIT
  DefaultJob : .NET 6.0.4 (6.0.422.16404), X64 RyuJIT


|            Method |       Mean |     Error |    StdDev |
|------------------ |-----------:|----------:|----------:|
|           markdig |   1.979 ms | 0.0221 ms | 0.0185 ms |
|             cmark |   2.571 ms | 0.0081 ms | 0.0076 ms |
|    CommonMark.NET |   2.016 ms | 0.0169 ms | 0.0158 ms |
|     MarkdownSharp | 221.455 ms | 1.4442 ms | 1.3509 ms |
  • Markdig is roughly x100 times faster than MarkdownSharp
  • 20% faster than the reference cmark C implementation

If you are using this library and find it useful for your project, please consider a donation for it!

Donate

Credits

Thanks to the fantastic work done by John Mac Farlane for the CommonMark specs and all the people involved in making Markdown a better standard!

This project would not have been possible without this huge foundation.

Thanks also to the project BenchmarkDotNet that makes benchmarking so easy to setup!

Some decoding part (e.g HTML EntityHelper.cs) have been re-used from CommonMark.NET

Thanks to the work done by @clarkd on the JIRA Link extension (https://github.com/clarkd/MarkdigJiraLinker), now included with this project!

Author

Alexandre MUTEL aka xoofx

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net452 net46 net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETCoreApp 3.1

    • No dependencies.
  • .NETFramework 4.5.2

  • .NETStandard 2.0

  • .NETStandard 2.1

    • No dependencies.
  • net6.0

    • No dependencies.

NuGet packages (214)

Showing the top 5 NuGet packages that depend on Markdig:

Package Downloads
ppy.osu.Framework

A 2D application/game framework written with rhythm games in mind.

Westwind.AspNetCore.Markdown

This library provides Markdown support for ASP.NET Core applications: * Markdown TagHelper - embed static markdown text from files, urls or bind model data * Markdown Page Handler Middleware to render Markdown files in your site * Markdown Parsing Support via Markdown.Parse() and Markdown.ParseHtmlString() * Markdown Parsing from Files via Markdown.ParseFromFile() and .ParseFromFileAsync() * Markdown Parsing from URL via Markdown.ParseFromUrl() and .ParseFromUrlAsync() * Supports basic HTML Sanitation * TagHelper supports White Space Normalization * Customization of Markdown Processing Options For similar features in System.Web based classic ASP.NET apps see `Westwind.Web.Markdown`.

Octostache

Variable substitution syntax used in Octopus Deploy.

Indice.AspNetCore

Indice.AspNetCore Class Library

OO.Presentation.Component.Tools

Razor Tools Components technology server types and implementations for EasyDataCore infrastructure

GitHub repositories (89)

Showing the top 5 popular GitHub repositories that depend on Markdig:

Repository Stars
dotnet/maui
.NET MAUI is the .NET Multi-platform App UI, a framework for building native device applications spanning mobile, tablet, and desktop.
veler/DevToys
A Swiss Army knife for developers.
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
dodyg/practical-aspnetcore
Practical samples of ASP.NET Core 2.1, 2.2, 3.1, 5.0, 6.0 and 7.0 projects you can use. Readme contains explanations on all projects.
OrchardCMS/OrchardCore
Orchard Core is an open-source modular and multi-tenant application framework built with ASP.NET Core, and a content management system (CMS) built on top of that framework.
Version Downloads Last updated
0.30.4 169,176 9/27/2022
0.30.3 179,381 8/12/2022
0.30.2 567,444 4/23/2022
0.30.1 3,305 4/22/2022
0.30.0 41,780 4/21/2022
0.29.0 1,156 4/20/2022
0.28.1 98,838 3/27/2022
0.28.0 104,192 3/11/2022
0.27.0 291,309 1/23/2022
0.26.0 888,694 8/27/2021
0.25.0 519,117 6/10/2021
0.24.0 739,259 3/20/2021
0.23.0 904,197 1/16/2021
0.22.1 374,640 12/2/2020
0.22.0 1,000,710 10/5/2020
0.21.1 408,537 8/17/2020
0.21.0 4,754 8/17/2020
0.20.0 660,345 4/18/2020
0.18.3 277,138 3/8/2020
0.18.2 696 3/8/2020
0.18.1 360,861 1/21/2020
0.18.0 458,593 10/24/2019
0.17.1 536,056 7/4/2019
0.17.0 401,516 5/11/2019
0.16.0 393,267 2/25/2019
0.15.7 112,406 1/11/2019
0.15.6 19,797 12/28/2018
0.15.5 59,438 12/11/2018
0.15.4 395,754 10/7/2018
0.15.3 15,378 9/26/2018
0.15.2 192,130 8/21/2018
0.15.1 72,779 7/10/2018
0.15.0 383,563 4/4/2018
0.14.9 282,190 1/15/2018
0.14.8 153,623 12/5/2017
0.14.7 25,483 11/25/2017
0.14.6 34,808 11/21/2017
0.14.5 6,766 11/18/2017
0.14.4 2,747 11/18/2017
0.14.3 33,980 11/1/2017
0.14.2 2,746 11/1/2017
0.14.1 5,692 10/27/2017
0.14.0 2,744 10/27/2017
0.13.4 25,100 10/17/2017
0.13.3 60,547 8/30/2017
0.13.2 11,903 8/29/2017
0.13.1 137,079 8/21/2017
0.13.0 8,053 8/3/2017
0.12.4 19,575 7/31/2017
0.12.3 34,077 6/26/2017
0.12.2 5,923 6/18/2017
0.12.1 58,094 5/29/2017
0.12.0 2,794 5/28/2017
0.11.0 19,143 5/8/2017
0.10.7 25,012 4/1/2017
0.10.6 92,571 2/24/2017
0.10.5 53,613 2/14/2017
0.10.4 248,499 12/12/2016
0.10.3 39,421 11/29/2016
0.10.2 2,689 11/26/2016
0.10.1 4,794 11/19/2016
0.10.0 11,314 10/16/2016
0.9.1 3,623 10/11/2016
0.9.0 3,562 10/11/2016
0.8.5 5,287 9/23/2016
0.8.4 2,852 9/22/2016
0.8.3 3,241 9/22/2016
0.8.2 3,172 9/22/2016
0.8.1 3,153 9/21/2016
0.8.0 3,148 9/19/2016
0.7.5 3,006 9/18/2016
0.7.4 10,371 7/30/2016
0.7.3 4,177 7/23/2016
0.7.2 6,176 7/20/2016
0.7.1 5,079 6/30/2016
0.7.0 3,090 6/27/2016
0.6.2 2,882 6/25/2016
0.6.1 2,929 6/24/2016
0.6.0 2,858 6/24/2016
0.5.12 2,836 6/23/2016
0.5.11 2,840 6/23/2016
0.5.10 2,845 6/22/2016
0.5.9 31,776 6/21/2016
0.5.8 2,900 6/21/2016
0.5.7 2,898 6/20/2016
0.5.6 2,854 6/20/2016
0.5.5 2,863 6/20/2016
0.5.4 2,854 6/19/2016
0.5.3 2,866 6/19/2016
0.5.2 2,864 6/17/2016
0.5.1 3,037 6/15/2016
0.5.0 2,855 6/15/2016
0.4.0 3,088 6/13/2016
0.3.4 2,854 6/10/2016
0.3.3 2,915 6/10/2016
0.3.2 2,847 6/9/2016
0.3.1 2,832 6/9/2016
0.3.0 2,838 6/8/2016
0.2.1 2,839 6/6/2016
0.2.0 2,916 5/30/2016
0.1.1 2,838 5/30/2016
0.1.0 3,987 5/25/2016