• Stars
    star
    277
  • Rank 148,875 (Top 3 %)
  • Language
    C#
  • License
    Apache License 2.0
  • Created over 11 years ago
  • Updated 28 days ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A library for converting HTML to markdown syntax in C#

HTML2Markdown

Converts HTML to Markdown.

Join the chat at https://gitter.im/Html2Markdown/Lobby


Html2Markdown

Build Status

Branch Status
master master
develop develop

Code Quality

Codacy Badge

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>

Installing via NuGet

NuGet version

    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);

Customise

Create new IScheme implementation

Create your own implementation of IScheme and construct Converter with that.

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

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.