Buscar pacotes, repositórios e categorias de apps

Detalhes do pacotev1.3.2

html2md

Uma biblioteca para converter HTML em Markdown. Suporta CommonMark, tabelas simples e regras personalizadas de conversão.

AndroidiOSWebmacOSWindowsLinux
Downloads em 30 dias
78,3 mil
Curtidas
63
Pontos Pub
140

Instalar pacote

flutter pub add html2md

Visão geral do pacote

Orientação gerada a partir de informações públicas. Apenas para referência.

Um pacote Flutter/Dart que converte conteúdo HTML para formato Markdown, com suporte a padrões CommonMark, renderização básica de tabelas e regras de conversão personalizáveis. É ideal para aplicações que precisam transformar texto rico em HTML em Markdown limpo e legível, como editores de conteúdo, ferramentas de documentação ou plataformas de blog. A biblioteca é compatível com todas as principais plataformas, incluindo Android, iOS, Web, macOS, Windows e Linux, tornando-a versátil para desenvolvimento multiplataforma. Sua extensibilidade permite que os desenvolvedores definam lógica de análise personalizada para casos de uso específicos.

Casos de uso

  • Convertendo e-mails HTML para Markdown
  • Renderização de posts de blog a partir de fontes HTML
  • Criando editores de conteúdo com saída em Markdown
  • Transformando HTML gerado pelo usuário em Markdown estruturado

Principais recursos

  • Suporta a especificação CommonMark
  • Gerencia tabelas simples
  • Regras de conversão personalizáveis
  • Compatibilidade multiplataforma
  • Leve e fácil de integrar

Indicado para

  • sistemas de gerenciamento de conteúdo
  • Geradores de documentação
  • Aplicativos de anotações baseados em Markdown
  • Aplicativos que processam HTML enviado por usuários

Considerações

  • Suporte limitado para estruturas HTML complexas
  • Regras personalizadas exigem implementação adicional
  • Pode não preservar todos os atributos de estilo HTML
  • Não otimizado para documentos HTML muito grandes

README original

Snapshot do README original do repositório-fonte vinculado. Consulte o repositório para o conteúdo mais recente.

English | 简体中文

html2md

Pub Build status

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

Usage

A simple usage example:

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

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

In flutter, you can use the flutter_markdown for rendering:

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 = '<h1>HTML2MD Demo</h1>';
    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!

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:

<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 Header Second Header
Content Cell Content Cell
Content Cell Content Cell

Custom Rules

Want to customize element converting? Write your rules!

Rule fields explaination

final String name; // unique rule name
final List<String>? 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 post to a link

<aside class="onebox">
  <header class="source">
      <img src="https://discoursesite/uploads/default/original/1X/test.png" class="site-icon" width="32" height="32">
      <a href="https://events.google.com/io/program/content?4=topic_flutter&amp;lng=zh-CN" target="_blank" rel="noopener">Google I/O 2021</a>
  </header>
</aside>
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.

Inspiration

html2md is basicly a simplify version of Node's turndown

License

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

Categorias

Dependências

Lista de dependências 2 itens

Repositório-fonte

Projetos que usam este pacote