Converts HTML to Markdown.
| Branch | Status |
|---|---|
master |  |
develop |  |
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.
Install-Package Html2Markdownvarhtml="Something to <strong>convert</strong>";varconverter=newConverter();varmarkdown=converter.Convert(html);varpath="file.html";varconverter=newConverter();varmarkdown=converter.ConvertFile(path);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.
usingAngleSharp.Dom;usingHtml2Markdown;varoptions=newConverterOptions();options.TagRenderers.Add(newMarkTagRenderer());varconverter=newConverter(options);varmarkdown=converter.Convert("<mark>highlighted</mark>");publicsealedclassMarkTagRenderer:IHtmlTagRenderer{publicstringTagName=>"mark";publicstringRender(IElementelement,HtmlTagRenderingContextcontext){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 are preserved as raw HTML by default. Enable GitHub-Flavoured Markdown table conversion when needed:
varoptions=newConverterOptions{ConvertTables=true};varconverter=newConverter(options);varmarkdown=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.
The library emits OpenTelemetry-compatible traces and metrics through the built-in .NET diagnostics APIs, so no additional package reference is required. Telemetry is only collected when your application subscribes to it.
Both the ActivitySource and the Meter are named Html2Markdown, which is
exposed as Html2Markdown.Observability.ActivityConfig.ServiceName.
| Signal | Name | Details |
|---|---|---|
| Trace | Render <tag> | An activity is started for each HTML element that is rendered, for example Render strong. |
| Metric | html.elements.rendered | Counter of rendered HTML elements, tagged with tag (the element's local name, e.g. p). |
Subscribe with the OpenTelemetry SDK:
usingHtml2Markdown.Observability;builder.Services.AddOpenTelemetry().WithTracing(tracing =>tracing.AddSource(ActivityConfig.ServiceName)).WithMetrics(metrics =>metrics.AddMeter(ActivityConfig.ServiceName));Version 8 is a breaking release. Read the version 7 to 8 migration guide before upgrading.
This library is showcased at http://html2markdown.bayn.es.
For those interested in contributing then please read the guidelines
This project is licensed under Apache License 2.0.