html2md 0.5.1

Dart native js
Flutter Android iOS web

Convert html to markdown in Dart.

html2md #

Build status

Convert html to markdown in Dart. A simplify version of node's turndown.

Usage #

A simple usage example:

import 'package:html2md/html2md.dart' as html2md;

main() {
  var html = '<h1>HTML2MD Demo</h1>';
  print(html2md.convert(html));
}

Config #

You can config convert style by passing styleOptions to convert, elements that should be ignored also can be set with ignore:

html2md.convert(html, styleOptions: { 'headingStyle': 'atx' }, ignore: ['script']);

The default and available style options:

NameDefaultOptions
headingStyle"setext""setext", "atx"
hr"* * *""* * *", "- - -", "_ _ _"
bulletListMarker"*""*", "-", "_"
codeBlockStyle"indented""indented", "fenced"
fence"```""```", "~~~"
emDelimiter"_""_", "*"
strongDelimiter"**""**", "__"
linkStyle"inlined""inlined", "referenced"
linkReferenceStyle"full""full", "collapsed", "shortcut"

Table support #

Basic table converting is supported!

Html table source:

<table>
    <tr>
        <th>First Header</th>
        <th>First Header</th> 
    </tr>
    <tr>
        <td>Content Cell</td>
        <td>Content Cell</td>
    </tr>
    <tr>
        <td>Content Cell</td>
        <td>Content Cell</td>
    </tr>
</table>

The converted markdown source:

| First Header  | Second Header |
| ----- | ----- |
| Content Cell  | Content Cell  |
| Content Cell  | Content Cell  |

The converted markdown table:

First HeaderSecond Header
Content CellContent Cell
Content CellContent Cell

Test #

pub run test

Features and bugs #

Please file feature requests and bugs at the issue tracker.

License #

Created from templates made available by Stagehand under a BSD-style license.

3
likes
90
pub points
95%
popularity

Convert html to markdown in Dart.

Repository (GitHub)
View/report issues

Documentation

API reference

Uploader

jaroncn@gmail.com

License

BSD (LICENSE)

Dependencies

html, path

More

Packages that depend on html2md