ReverseMarkdown 6.2.1

Meet ReverseMarkdown

ReverseMarkdown is a HTML to Markdown converter library in C#. v6 uses AngleSharp's HTML5-compliant parser and a Markdown DOM pipeline for reliable, performant conversion.

📖 Full documentation: mysticmind.github.io/reversemarkdown-net

Using v5.x? See the v5.x documentation.

If you have used and benefitted from this library, please feel free to sponsor me!

Install

dotnet add package ReverseMarkdown

Quick start

var converter = new ReverseMarkdown.Converter();

string html = "This a sample <strong>paragraph</strong> from <a href=\"http://test.com\">my site</a>";

string result = converter.Convert(html);
// This a sample **paragraph** from [my site](http://test.com)

With configuration and a flavor:

var config = new ReverseMarkdown.Config
{
    Flavor = Config.MarkdownFlavor.GitHub,
    Formatting = { RemoveComments = true },
    Links = { SmartHref = true },
};

var converter = new ReverseMarkdown.Converter(config);

Real-world HTML often needs cleaning up first. Config.Preprocess is a chainable pipeline applied to the source markup before it converts:

var config = new ReverseMarkdown.Config();
config.Preprocess
    .RemoveScripts()                        // <script>/<noscript> and on* handlers
    .RemoveStyles()                         // style attributes, <style>, stylesheet <link>
    .Remove("nav, footer, .advertisement")  // drop page chrome
    .Unwrap("span, font")                   // keep the text, lose the wrapper
    .Rename("b", "strong");

var markdown = new ReverseMarkdown.Converter(config).Convert(html);

Features

• Seven output flavors - Default, GitHub, CommonMark, Slack, Telegram, MultiMarkdown, and Pandoc, selected via the Flavor enum.
• Spec-compliant round-trips - CommonMark and GitHub Flavored Markdown round-trip at 100% against canonical cmark-gfm; MultiMarkdown and Pandoc verified against canonical pandoc.
• HTML preprocessing - clean up the source before it converts with a chainable pipeline of 23 helpers: remove or unwrap elements, rename or replace them, strip styles, scripts and attributes, recover formatting from inline CSS (Word/Outlook exports), and resolve relative URLs. Plug in your own steps too. See HTML Preprocessing.
• Extensible - custom readers (IMdReader + [MarkdownReader]), tag aliases, and a Parse/Render Markdown DOM for direct transformation.
• Tables, links, and images - nested tables and captions, configurable handling for lists inside table cells, smart href handling, URI-scheme whitelisting, and base64 image handling (include / skip / save to disk).
• Broad framework support - targets netstandard2.0, net8.0, net9.0, and net10.0 (runs on .NET Framework 4.6.1+, .NET Core 2.0+, Mono, and Unity).
• Trimming and Native AOT ready - the default conversion path uses no reflection; add custom readers with RegisterReader under trimming/AOT. See Supported Frameworks.

Performance

v6 replaces the v5 HtmlAgilityPack engine with an AngleSharp HTML5 parser feeding a Markdown DOM and per-flavor writers. It is roughly 2–2.6× faster than v5 and allocates about 2.7× less memory.

Measured with BenchmarkDotNet on .NET 9.0 (Apple M1), comparing published ReverseMarkdown 5.5.0 vs 6.0.0 on the same inputs (lower is better):

See the Performance guide for details and how to reproduce the benchmark.

Documentation

The full guide lives at mysticmind.github.io/reversemarkdown-net:

• Getting Started
• Performance
• Flavors
• Configuration reference
• HTML Preprocessing
• Extending (custom readers, recipes)
• Migrating from v5

Acknowledgements

This library's initial implementation ideas from the Ruby based Html to Markdown converter xijo/reverse_markdown.

Copyright

Copyright © Babu Annamalai

License

ReverseMarkdown is licensed under the MIT License.