https://github.com/jarontai/html2md

A library for converting HTML to Markdown in Dart. It supports CommonMark, simple table and custom converting rules. 将html转换为markdown的Dart库，支持CommonMark、简单表格以及自定义转换规则。
https://github.com/jarontai/html2md

converter dart html markdown

Last synced: 5 months ago
JSON representation

A library for converting HTML to Markdown in Dart. It supports CommonMark, simple table and custom converting rules. 将html转换为markdown的Dart库，支持CommonMark、简单表格以及自定义转换规则。

• Host: GitHub
• URL: https://github.com/jarontai/html2md
• Owner: jarontai
• License: bsd-2-clause
• Created: 2018-04-04T09:00:29.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-29T12:34:02.000Z (about 2 years ago)
• Last Synced: 2025-11-01T15:21:03.552Z (9 months ago)
• Topics: converter, dart, html, markdown
• Language: Dart
• Homepage: https://pub.dev/packages/html2md
• Size: 110 KB
• Stars: 57
• Watchers: 3
• Forks: 27
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
English | [简体中文](./README_CN.md)

# html2md

[![Pub](https://img.shields.io/pub/v/html2md.svg)](https://pub.dev/packages/html2md)

[![Build status](https://travis-ci.org/jarontai/html2md.svg)](https://travis-ci.org/jarontai/html2md)

A library for converting HTML to Markdown in Dart. It supports CommonMark, simple table and custom converting rules.

## Usage

A simple usage example:

~~~dart

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

main() {

    var html = '
HTML2MD Demo
';

    print(html2md.convert(html));

}

~~~


In flutter, you can use the [flutter_markdown](https://pub.dev/packages/flutter_markdown) for rendering:

~~~dart

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

import 'package:flutter_markdown/flutter_markdown.dart';

build(BuildContext context) {

    // Caution!

    // This is not best practice, you should not call convert in build

    // and the converted markdown should put in state.

    var html = '
HTML2MD Demo
';

    var markdown = html2md.convert(html);

    return Markdown(data: markdown);

}

~~~


## Config

You can config convert style by passing `styleOptions` to `convert`, elements that should be ignored also can be set with `ignore`. If you want to customize element converting, use custom [rules](#custom-rules)!

~~~dart

html2md.convert(html,

    styleOptions: {'headingStyle': 'atx'},

    ignore: ['script'],

    rules: [Rule('custom')]);

~~~

The default and available style options:

| Name        | Default           | Options  |

| ------------- |:-------------:| -----:|

| 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:

    

        

            First Header

            First Header 

        

        

            Content Cell

            Content Cell

        

        

            Content Cell

            Content Cell

        

    

The converted markdown source:

    | First Header  | Second Header |

    | ----- | ----- |

    | Content Cell  | Content Cell  |

    | Content Cell  | Content Cell  |

The converted markdown table:

| First Header  | Second Header |

| ----- | ----- |

| Content Cell  | Content Cell  |

| Content Cell  | Content Cell  |

## Custom Rules

Want to customize element converting? Write your rules!

Rule fields explaination

~~~dart

final String name; // unique rule name

final List? filters; // simple element name filters, e.g. ['aside']

final FilterFn? filterFn; // function for building complex element filter logic

final Replacement? replacement; // function for doing the replacing

final Append? append; // function for appending content

~~~

Rule example - Convert the onebox section of [discourse](https://www.discourse.org/) post to a link

~~~html

  

      

      Google I/O 2021

  

~~~

~~~dart

Rule(

  'discourse-onebox',

  filterFn: (node) {

    // Find aside with onebox class

    if (node.nodeName == 'aside' &&

        node.className.contains('onebox')) {

        return true;

    }

    return false;

  },

  replacement: (content, node) {

    // find the first a element under header

    var header = node.firstChild;

    var link = header!

        .childNodes()

        .firstWhere((element) => element.nodeName == 'a');

    var href = link.getAttribute('href');

    if (href != null && href.isNotEmpty) {

      return '[$href]($href)'; // build the link

    }

    return '';

  },

)

~~~

## Test

    dart run test

## Features and bugs

Please file feature requests and bugs at the [issue tracker][tracker].

[tracker]: https://github.com/jarontai/html2md/issues

## Inspiration

html2md is basicly a simplify version of Node's [turndown](https://github.com/domchristie/turndown)

## License

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

[license](https://github.com/jarontai/html2md/blob/master/LICENSE).