docs: Documentation for quill_html_converter

packages/README.md

@@ -3,6 +3,8 @@
 This folder contains packages that add more features to the [FlutterQuill](../README.md) 
 that might be outside of the packages main purpose
 
+Pub: [quill_html_converter](https://pub.dev/packages/quill_html_converter)
+
 ## Table of contents
 - [Flutter Quill Packages](#flutter-quill-packages)
   - [Table of contents](#table-of-contents)

packages/quill_html_converter/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 0.0.1
+## 0.0.1-experimental.1
 
-* TODO: Describe initial release.
+* initial release.

packages/quill_html_converter/lib/quill_html_converter.dart

@@ -7,26 +7,55 @@ import 'package:html2md/html2md.dart' as html2md;
 import 'package:vsc_quill_delta_to_html/vsc_quill_delta_to_html.dart'
     as conventer show ConverterOptions, QuillDeltaToHtmlConverter;
 
-import 'src/packages/delta_markdown/delta_markdown.dart' show markdownToDelta;
+import 'src/packages/delta_markdown/delta_markdown.dart' as delta_markdown
+    show markdownToDelta;
 
 typedef ConverterOptions = conventer.ConverterOptions;
 
+/// A extension for [Delta] which comes from `flutter_quill` to extends
+/// the functionality of it to support converting the [Delta] to/from HTML
 extension DeltaHtmlExt on Delta {
+  /// Convert the [Delta] instance to HTML Raw string
+  ///
+  /// It will run using the following steps:
+  ///
+  /// 1. Convert the [Delta] to json using [toJson]
+  /// 2. Cast the json map as `List<Map<String, dynamic>>`
+  /// 3. Pass it to the conventer `vsc_quill_delta_to_html` which is a package
+  /// that designed specifically for converting the quill delta to html
   String toHtml({ConverterOptions? options}) {
+    final json = toJson();
     final html = conventer.QuillDeltaToHtmlConverter(
-      List.castFrom(toJson()),
+      List.castFrom(json),
       options,
     ).convert();
     return html;
   }
 
+  /// Convert the HTML Raw string to [Delta]
+  ///
+  /// It will run using the following steps:
+  ///
+  /// 1. Convert the html to markdown string using `html2md` package
+  /// 2. Convert the markdown string to quill delta json string
+  /// 3. Decode the delta json string to [Delta]
+  ///
+  /// for more [info](https://github.com/singerdmx/flutter-quill/issues/1100)
   static Delta fromHtml(String html) {
+    final markdown = html2md
+        .convert(
+          html,
+        )
+        .replaceAll('unsafe:', '');
+    final deltaJsonString = delta_markdown.markdownToDelta(markdown);
+    final deltaJson = jsonDecode(deltaJsonString);
+    if (deltaJson is! List) {
+      throw ArgumentError(
+        'The delta json string should be of type list when jsonDecode() it',
+      );
+    }
     return Delta.fromJson(
-      jsonDecode(
-        markdownToDelta(
-          html2md.convert(html),
-        ),
-      ),
+      deltaJson,
     );
   }
 }

packages/quill_html_converter/pubspec.yaml

@@ -20,7 +20,9 @@ dependencies:
     sdk: flutter
   flutter_quill: ^8.5.1
   vsc_quill_delta_to_html: ^1.0.3
-  html2md: ^1.3.1
+  html2md:
+    git: https://github.com/jarontai/html2md.git
+  # markdown: ^7.1.1
   charcode: ^1.3.1
   collection: ^1.17.2