Markdig

A fast, powerful, CommonMark compliant, extensible Markdown processor for .NET

Description

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

Code Quality Rank: L1

Programming language: C#

License: BSD 2-clause "Simplified" License

Tags: HTML     Documentation     CommonMark     Markdown     Markdown Processors     md     md2html    

Latest version: v0.27.0

README

Markdig

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

• Very fast parser and html renderer (no-regexp), very lightweight in terms of GC pressure. See benchmarks
• Abstract Syntax Tree with precise source code location for syntax tree, useful when building a Markdown editor.
  • Checkout MarkdownEditor for Visual Studio powered by Markdig!
• Converter to HTML
• Passing more than 600+ tests from the latest CommonMark specs (0.30)
• Includes all the core elements of CommonMark:
  • including GFM fenced code blocks.
    
• Extensible architecture
  • Even the core Markdown/CommonMark parsing is pluggable, so it allows to disable builtin Markdown/Commonmark parsing (e.g Disable HTML parsing) or change behaviour (e.g change matching # of a headers with @)
    
• [Roundtrip support](./src/Markdig/Roundtrip.md): Parses trivia (whitespace, newlines and other characters) to support lossless parse ⭢ render roundtrip. This enables changing markdown documents without introducing undesired trivia changes.
• Built-in with 20+ extensions, including:
  • 2 kind of tables:
  • [Pipe tables](src/Markdig.Tests/Specs/PipeTableSpecs.md) (inspired from GitHub tables and PanDoc - Pipe Tables)
  • [Grid tables](src/Markdig.Tests/Specs/GridTableSpecs.md) (inspired from Pandoc - Grid Tables)
  • [Extra emphasis](src/Markdig.Tests/Specs/EmphasisExtraSpecs.md) (inspired from Pandoc - Emphasis and Markdown-it)
  • strike through ~~,
  • Subscript ~
  • Superscript ^
  • Inserted ++
  • Marked ==
  • [Special attributes](src/Markdig.Tests/Specs/GenericAttributesSpecs.md) or attached HTML attributes (inspired from PHP Markdown Extra - Special Attributes)
  • [Definition lists](src/Markdig.Tests/Specs/DefinitionListSpecs.md) (inspired from PHP Markdown Extra - Definitions Lists)
  • [Footnotes](src/Markdig.Tests/Specs/FootnotesSpecs.md) (inspired from PHP Markdown Extra - Footnotes)
  • [Auto-identifiers](src/Markdig.Tests/Specs/AutoIdentifierSpecs.md) for headings (similar to Pandoc - Auto Identifiers)
  • [Auto-links](src/Markdig.Tests/Specs/AutoLinks.md) generates links if a text starts with http:// or https:// or ftp:// or mailto: or www.xxx.yyy
  • [Task Lists](src/Markdig.Tests/Specs/TaskListSpecs.md) inspired from Github Task lists.
  • [Extra bullet lists](src/Markdig.Tests/Specs/ListExtraSpecs.md), supporting alpha bullet a. b. and roman bullet (i, ii...etc.)
  • [Media support](src/Markdig.Tests/Specs/MediaSpecs.md) for media url (youtube, vimeo, mp4...etc.) (inspired from this CommonMark discussion)
  • [Abbreviations](src/Markdig.Tests/Specs/AbbreviationSpecs.md) (inspired from PHP Markdown Extra - Abbreviations)
  • [Citation](src/Markdig.Tests/Specs/FigureFooterAndCiteSpecs.md) text by enclosing ""..."" (inspired by this CommonMark discussion )
  • [Custom containers](src/Markdig.Tests/Specs/CustomContainerSpecs.md) similar to fenced code block ::: for generating a proper <div>...</div> instead (inspired by this CommonMark discussion )
  • [Figures](src/Markdig.Tests/Specs/FigureFooterAndCiteSpecs.md) (inspired from this CommonMark discussion)
  • [Footers](src/Markdig.Tests/Specs/FigureFooterAndCiteSpecs.md) (inspired from this CommonMark discussion)
  • [Mathematics](src/Markdig.Tests/Specs/MathSpecs.md)/Latex extension by enclosing $$ for block and $ for inline math (inspired from this CommonMark discussion)
  • [Soft lines as hard lines](src/Markdig.Tests/Specs/HardlineBreakSpecs.md)
  • [Emoji](src/Markdig.Tests/Specs/EmojiSpecs.md) support (inspired from Markdown-it)
  • [SmartyPants](src/Markdig.Tests/Specs/SmartyPantsSpecs.md) (inspired from Daring Fireball - SmartyPants)
  • [Bootstrap](src/Markdig.Tests/Specs/BootstrapSpecs.md) class (to output bootstrap class)
  • [Diagrams](src/Markdig.Tests/Specs/DiagramsSpecs.md) extension whenever a fenced code block contains a special keyword, it will be converted to a div block with the content as-is (currently, supports mermaid and nomnoml diagrams)
  • [YAML Front Matter](src/Markdig.Tests/Specs/YamlSpecs.md) to parse without evaluating the front matter and to discard it from the HTML output (typically used for previewing without the front matter in MarkdownEditor)
  • [JIRA links](src/Markdig.Tests/Specs/JiraLinks.md) to automatically generate links for JIRA project references (Thanks to @clarkd: https://github.com/clarkd/MarkdigJiraLinker)
• Starting with Markdig version 0.20.0+, Markdig is compatible only with NETStandard 2.0, NETStandard 2.1, NETCoreApp 2.1 and NETCoreApp 3.1.

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

• WPF/XAML Markdown Renderer: markdig.wpf
• WPF/XAML Markdown Renderer: Neo.Markdig.Xaml
• Syntax highlighting: Markdig.SyntaxHighlighting
• Syntax highlighting using ColorCode-Universal: Markdown.ColorCode
• Syntax highlighting using Prism.js: WebStoating.Markdig.Prism
• Embedded C# scripting: Markdig.Extensions.ScriptCs

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](src/Markdig.Tests/Specs/readme.md) 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:

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)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see [contributing.md](contributing.md).

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

Donate

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

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