Html2Markdown 8.1.2.185-beta

HTML2Markdown

Converts HTML to Markdown.

Build Status

Branch	Status
master
develop

Support

This project will currently convert the following HTML tags:-

• <a>
• <strong>
• <b>
• <em>
• <i>
• <br>
• <code>
• <h1>
• <h2>
• <h3>
• <h4>
• <h5>
• <h6>
• <blockquote>
• <img>
• <hr>
• <p>
• <pre>
• <ul>
• <ol>

The converter preserves the original HTML for <div>, <table>, <iframe>, and <canvas> elements, including their contents. Set ConverterOptions.ConvertTables to convert supported tables to GitHub-Flavoured Markdown instead.

Installing via NuGet

    Install-Package Html2Markdown

Usage

Strings

var html = "Something to <strong>convert</strong>";
var converter = new Converter();
var markdown = converter.Convert(html);

Files

var path = "file.html";
var converter = new Converter();
var markdown = converter.ConvertFile(path);

Custom tags

Register tag renderers when you need to add support for an unsupported tag or replace the default behaviour for a supported tag. Custom renderers receive the current HTML element and a rendering context that can render child nodes through the active renderer set.

using AngleSharp.Dom;
using Html2Markdown;

var options = new ConverterOptions();
options.TagRenderers.Add(new MarkTagRenderer());

var converter = new Converter(options);
var markdown = converter.Convert("<mark>highlighted</mark>");

public sealed class MarkTagRenderer : IHtmlTagRenderer
{
    public string TagName => "mark";

    public string Render(IElement element, HtmlTagRenderingContext context)
    {
        return $"=={context.RenderChildren(element)}==";
    }
}

If a custom renderer uses the same TagName as a built-in renderer, the custom renderer replaces the built-in behaviour for that tag. Tag names are matched case-insensitively, and options are copied when the Converter is constructed.

Tables

Tables are preserved as raw HTML by default. Enable GitHub-Flavoured Markdown table conversion when needed:

var options = new ConverterOptions { ConvertTables = true };
var converter = new Converter(options);
var markdown = converter.Convert("<table><tr><th>Name</th></tr><tr><td>Sam</td></tr></table>");

Enabled conversion creates a GitHub-Flavoured Markdown pipe table. It supports headers, align="left", align="center", and align="right", plus rowspan and colspan; spanned positions are represented by empty Markdown cells. Tables without a header use an empty synthetic header, and captions are emitted after the table. Tables with multiline cell content remain raw HTML because they cannot be represented safely as a Markdown table.

Documentation

Library Documentation

Migrating from version 7

Version 8 is a breaking release. Read the version 7 to 8 migration guide before upgrading.

Try it

This library is showcased at http://html2markdown.bayn.es.

Contributing

For those interested in contributing then please read the guidelines

License

This project is licensed under Apache License 2.0.