Flutter Markdown转换插件delta_markdown_converter的使用

Delta Markdown Converter

更新说明：

这是一个对原始的 delta_markdown 的分支版本，目的是为了兼容最新版本的 Flutter Quill，而 Flutter Quill 是由 quill_html_converter 所需要的。

Delta Markdown Converter 是一个用 Dart 编写的便携式 Markdown 库。它可以将 Markdown 转换为 Delta，并且可以将 Delta 转换回 Markdown。

注意：该转换器目前尚未准备好用于生产环境。

使用方法

以下是一个简单的示例，展示如何使用 delta_markdown_converter 进行 Markdown 和 Delta 的相互转换。

import 'package:delta_markdown/delta_markdown.dart';

void main() {
  // 示例 Markdown 字符串
  const markdown = 'Hello **Markdown**';

  // 将 Markdown 转换为 Delta
  final deltaJson = markdownToDelta(markdown);
  print('Markdown 转换为 Delta:\n$deltaJson');

  // 示例 Delta JSON 字符串
  const delta = r'[{"insert":"Hello "},{"insert":"Markdown","attributes":{"bold":true}},{"insert":"\n"}]';

  // 将 Delta 转换回 Markdown
  final markdownResult = deltaToMarkdown(delta);
  print('Delta 转换回 Markdown:\n$markdownResult');
}

输出结果：

• Markdown 转换为 Delta:

  [{"insert":"Hello "},{"insert":"Markdown","attributes":{"bold":true}},{"insert":"\n"}]

• Delta 转换回 Markdown:

  Hello **Markdown**

支持的功能

目前支持以下 Markdown 元素的转换：

• 加粗 (Bold)
• 斜体 (Italic)
• 链接 (Link)
• 引用块 (Blockquote)
• 标题 (Header)
• 列表 (List)
• 代码块 (Code Block)
• 图片 (Image)
• 水平线 (Horizontal Rule)

不支持的功能

由于 Markdown 本身的限制或 flutter_quill 的限制，以下功能暂不支持：

Markdown 不支持的功能：

• 背景色 (Background Color)
• 文本颜色 (Color)
• 字体 (Font)
• 字号 (Size)
• 删除线 (Strikethrough)
• 上标/下标 (Superscript/Subscript)
• 下划线 (Underline)
• 文本对齐方式 (Text Alignment)
• 文本方向 (Text Direction)
• 数学公式 (Formula)
• 视频 (Video)

flutter_quill 不支持的功能：

• 行内代码 (Inline Code)

已知限制

以下功能尚未实现，需要进一步开发：

• 缩进 (Indent)

目前测试用例较少，因此在复杂情况下，功能可能无法完全保证。

完整示例 Demo

以下是一个完整的 Flutter 示例，展示如何结合 delta_markdown_converter 在应用中使用。

import 'package:flutter/material.dart';
import 'package:delta_markdown/delta_markdown.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Delta Markdown Converter')),
        body: MarkdownConverterDemo(),
      ),
    );
  }
}

class MarkdownConverterDemo extends StatefulWidget {
  [@override](/user/override)
  _MarkdownConverterDemoState createState() => _MarkdownConverterDemoState();
}

class _MarkdownConverterDemoState extends State<MarkdownConverterDemo> {
  String _markdownInput = 'Hello **Markdown**';
  String _deltaOutput = '';
  String _markdownOutput = '';

  void _convertMarkdownToDelta() {
    setState(() {
      _deltaOutput = markdownToDelta(_markdownInput);
    });
  }

  void _convertDeltaToMarkdown() {
    setState(() {
      _markdownOutput = deltaToMarkdown(_deltaOutput);
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Padding(
      padding: const EdgeInsets.all(16.0),
      child: Column(
        children: [
          TextField(
            onChanged: (value) => _markdownInput = value,
            decoration: InputDecoration(labelText: '输入 Markdown'),
          ),
          SizedBox(height: 16),
          ElevatedButton(
            onPressed: _convertMarkdownToDelta,
            child: Text('Markdown 转 Delta'),
          ),
          SizedBox(height: 16),
          Text('Delta 输出:\n$_deltaOutput'),
          SizedBox(height: 16),
          ElevatedButton(
            onPressed: _convertDeltaToMarkdown,
            child: Text('Delta 转 Markdown'),
          ),
          SizedBox(height: 16),
          Text('Markdown 输出:\n$_markdownOutput'),
        ],
      ),
    );
  }
}