baynezy / html2markdown Goto Github PK

View Code? Open in Web Editor NEW

270.0 10.0 83.0 3.96 MB

A library for converting HTML to markdown syntax in C#

License: Apache License 2.0

C# 97.15% PowerShell 2.85%

c-sharp html2markdown markdown html nuget

html2markdown's Introduction

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>

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

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.

html2markdown's People

Contributors

Stargazers

Watchers

Forkers

theaob mattiascibien jamesholcomb huoxudong125 flyeven leafney wyrover wiltodelta qiyeboy geffzhang wei772 hdjn axnserv tlaster azraelrabbit liyang-love thewhitelama gitter-badger lemon-go icnocop vyruz1986 iarovikov lasrol yehuangcn attackgithub xin-lai martinvicha ywscr leornardzhou stevetemple the-thirteenth-fox pschott stephanevg lanicon simplificaci caoyongxu seanwallawalla-forks lordlammington flensrocker yuyu2you gamblingmaster2020 whistyun 365-w aboryslawski ntxsay fredatgithub youssefazaroual lihuibng

html2markdown's Issues

<blockquote> creates too much whitespace

HTML Entities should be converted

Convert to Portable Library

Update the project to be a portable class library

Convert to portable library
Make sure unit tests are working
Work out how to do versioning properly
Fix build to AppVeyor - including NuGet build

Line breaks kill italics

I have some HTML like this:

<i>Some text</br></i>

It's a strange way of doing it, but I have no control over the HTML. The problem is that this causes the converter to incorrectly render the markdown. It would be nice if elements in between the </i> didn't break it.

<blockquote> with attributes do not convert correctly

HTML Comments should be removed

Add commit template to project

<meta> tags should be removed

Headings with attributes do not get converted

Add support for title attribute in anchor tags

Images for README

Do not convert markdown inside block level elements

HTML block level tags div and table should not get converted. Any HTML inside these tags should also not get converted to Markdown.

Fix contributing guidelines

The Contributing Markdown is broken.
Just link to in it in the README

Configure AppVeyor via YML

Instead of using the GUI for configuration utilise the .yml config

Nested HTML in <blockquote> does't convert properly

<blockquote>
    <p class="right" align="right">
            <em>“Qualquer coisa que possas fazer ou sonhar, podes começá-la. A ousadia encerra em si mesma genialidade, poder e magia.<br />
            Ouse fazer, e o poder lhe será dado!”</em><br />
            <strong>— Johann Wolfgang von Goethe</strong>
    </p>
</blockquote>

Creates

>

            *“Qualquer coisa que possas fazer ou sonhar, podes começá-la. A ousadia encerra em si mesma genialidade, poder e magia.  

            Ouse fazer, e o poder lhe será dado!”*  

            **— Johann Wolfgang von Goethe**

Should be

> *“Qualquer coisa que possas fazer ou sonhar, podes começá-la. A ousadia encerra em si mesma genialidade, poder e magia.  
> Ouse fazer, e o poder lhe será dado!”*  
> **— Johann Wolfgang von Goethe**

Update AppVeyor integration to deploy to NuGet

ConvertFile and Convert should be static

Please make methods Convert and ConvertFile static. I see no point, why the Converter object has to be created.

Add ability to convert from file

Update Library to use HtmlAgilityPack to simplify conversions

http://htmlagilitypack.codeplex.com/

<head> tags should be removed

Generate documentation automatically on build

Modify to use depth first search

Change over the codebase to convert HTML by walking the graph, using depth first search. This will underpin subsequent features.

Remove extra white space from each end of the output

anchor with attribute after href

The existing regular expression for anchor does not match other attributes after href ex:

anchor

you can fix it with this regexp :

@"<a.+?href\s*=\s*'""['""][^>]*>([^<]+)"

Does not handle multiline <pre> tags properly

<pre><code>Install-Package Html2Markdown
</code></pre>

Does not convert properly

<pre><code>var converter = new Converter();
var result = converter.Convert(html);
</code></pre>

Does not convert properly

Empty links should be removed

Html like this <a name="curio"></a> should be removed

<html> tags should be removed

Set up custom domain for github pages

<hr> tags with attributes don't convert

Add comment width hint to commit template

Update README to link to site

Update README to show a breakdown of the build status to show both

master
develop

Contributing

https://help.github.com/articles/helping-people-contribute-to-your-project/

Add Code of Conduct
Add issue template
Add pull request template

Add licensing information

Integrate CI server with Slack

Add Waffle badge to README

<hr> tags with missing trailing slash don't convert

Missing method

Getting this error after updating to 1.0.3

System.MissingMethodException : Method not found: 'Void LinqExtensions.EachExtension.Each(System.Collections.Generic.IEnumerable`1<!!0>, System.Action`1<!!0>)'.

Updating LinqExtensions to 0.0.1.14396 fixes it.

baynezy / html2markdown Goto Github PK

html2markdown's Introduction

HTML2Markdown

Build Status

Support

Installing via NuGet

Usage

Strings

Files

Customise

Create new IScheme implementation

Try it

Contributing

License

html2markdown's People

Contributors

Stargazers

Watchers

Forkers

html2markdown's Issues

Recommend Projects

Recommend Topics

Recommend Org

Create new `IScheme` implementation