mark down support added

Author: alihassan143

CHANGELOG.md

@@ -1,3 +1,5 @@
+## 1.0.5
+* Markdown to pdf support added
 ## 1.0.4
 * Fix wrong styles of background color ([#31](https://github.com/alihassan143/htmltopdfwidgets/issues/31))
 * Add support for custom fonts ([#34](https://github.com/alihassan143/htmltopdfwidgets/pull/34)) by @hig-dev

README.md

@@ -1,12 +1,19 @@
 # HTMLtoPDFWidgets
 
 
-HTMLtoPDFWidgets is a Flutter package that allows you to convert HTML content into PDF documents with support for various Rich Text Editor formats. With this package, you can effortlessly generate PDF files that include elements such as lists, paragraphs, images, quotes, and headings.
+HTMLtoPDFWidgets is a Flutter package that allows you to convert HTML and Markdown content into PDF documents with support for various Rich Text Editor formats. With this package, you can effortlessly generate PDF files that include elements such as lists, paragraphs, images, quotes, and headings.
+
+## Help Maintenance
+
+I've been maintaining quite many repos these days and burning out slowly. If you could help me cheer up, buying me a cup of coffee will make my life really happy and get much energy out of it.
+
+<a href="https://www.buymeacoffee.com/alihassan13" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
 
 ## Features
 
 - Convert HTML content to PDF documents in Flutter apps
-- Support for Rich Text Editor formats
+- Support for Markdown to PDF conversion
+- Rich Text Editor formatting support
 - Seamless integration with your Flutter project
 - Lightweight and easy to use
 
@@ -16,7 +23,7 @@ Add the following dependency to your `pubspec.yaml` file:
 
 ```yaml
 dependencies:
-  htmltopdfwidgets: ^0.0.9+1
+  htmltopdfwidgets: ^1.0.5
 ```
 
 ## Usage
@@ -55,6 +62,47 @@ final htmlContent = '''
       }));
   await file.writeAsBytes(await newpdf.save());
 ```
+2. Converting Markdown to PDF:
+
+```dart
+final markDown = '''
+  # Basic Markdown Demo
+---
+The Basic Markdown Demo shows the effect of the four Markdown extension sets
+on formatting basic and extended Markdown tags.
+
+## Overview
+
+The Dart [markdown](https://pub.dev/packages/markdown) package parses Markdown
+into HTML. The flutter_markdown package builds on this package using the
+abstract syntax tree generated by the parser to make a tree of widgets instead
+of HTML elements.
+
+The markdown package supports the basic block and inline Markdown syntax
+specified in the original Markdown implementation as well as a few Markdown
+extensions. The markdown package uses extension sets to make extension
+management easy. There are four pre-defined extension sets; none, Common Mark,
+GitHub Flavored, and GitHub Web. The default extension set used by the
+flutter_markdown package is GitHub Flavored.
+
+The Basic Markdown Demo shows the effect each of the pre-defined extension sets
+has on a test Markdown document with basic and extended Markdown tags. Use the
+Extension Set dropdown menu to select an extension set and view the Markdown
+widget's output.
+
+## Comments
+
+Since GitHub Flavored is the default extension set, it is the initial setting
+for the formatted Markdown view in the demo.
+''';
+
+  final List<Widget> markdownWidgets = await HTMLToPdf().convertMarkdown(markDown);
+final markdownPdf = Document();
+markdownPdf.addPage(MultiPage(
+  build: (context) => markdownWidgets,
+));
+await File('markdown_example.pdf').writeAsBytes(await markdownPdf.save());
+```
 
 For more details on usage and available options, please refer to the [API documentation](https://pub.dev/documentation/htmltopdfwidgets/latest).
 
@@ -81,9 +129,5 @@ I use their Html To Document plugin as reference
 
 Happy PDF generation with HTMLtoPDFWidgets in your Flutter apps!
 
-## Help Maintenance
 
-I've been maintaining quite many repos these days and burning out slowly. If you could help me cheer up, buying me a cup of coffee will make my life really happy and get much energy out of it.
-
-<a href="https://www.buymeacoffee.com/alihassan13" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/purple_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
 

example/lib/main.dart

@@ -48,19 +48,59 @@ const htmlText = '''<h1>AppFlowyEditor</h1>
   <input type="checkbox" id="option3"> 
   <label for="option3">Option 3</label>
   ''';
+const String markDown = """
+# Basic Markdown Demo
+---
+The Basic Markdown Demo shows the effect of the four Markdown extension sets
+on formatting basic and extended Markdown tags.
 
+## Overview
+
+The Dart [markdown](https://pub.dev/packages/markdown) package parses Markdown
+into HTML. The flutter_markdown package builds on this package using the
+abstract syntax tree generated by the parser to make a tree of widgets instead
+of HTML elements.
+
+The markdown package supports the basic block and inline Markdown syntax
+specified in the original Markdown implementation as well as a few Markdown
+extensions. The markdown package uses extension sets to make extension
+management easy. There are four pre-defined extension sets; none, Common Mark,
+GitHub Flavored, and GitHub Web. The default extension set used by the
+flutter_markdown package is GitHub Flavored.
+
+The Basic Markdown Demo shows the effect each of the pre-defined extension sets
+has on a test Markdown document with basic and extended Markdown tags. Use the
+Extension Set dropdown menu to select an extension set and view the Markdown
+widget's output.
+
+## Comments
+
+Since GitHub Flavored is the default extension set, it is the initial setting
+for the formatted Markdown view in the demo.
+""";
 createDocument() async {
-  const filePath = 'example.pdf';
+  const filePath = 'html_example.pdf';
+  const markDownfilePath = 'markdown_example.pdf';
   final file = File(filePath);
+  final markdownfile = File(markDownfilePath);
   final newpdf = Document();
+  final markdownNewpdf = Document();
   final List<Widget> widgets = await HTMLToPdf().convert(
     htmlText,
   );
-
+  final List<Widget> markdownwidgets = await HTMLToPdf().convertMarkdown(
+    markDown,
+  );
   newpdf.addPage(MultiPage(
       maxPages: 200,
       build: (context) {
         return widgets;
       }));
+  markdownNewpdf.addPage(MultiPage(
+      maxPages: 200,
+      build: (context) {
+        return markdownwidgets;
+      }));
   await file.writeAsBytes(await newpdf.save());
+  await markdownfile.writeAsBytes(await markdownNewpdf.save());
 }

example/pubspec.lock

@@ -9,6 +9,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "3.6.1"
+  args:
+    dependency: transitive
+    description:
+      name: args
+      sha256: bf9f5caeea8d8fe6721a9c358dd8a5c1947b27f1cfaa18b39c301273594919e6
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.6.0"
   async:
     dependency: transitive
     description:
@@ -112,6 +120,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "4.0.0"
+  markdown:
+    dependency: transitive
+    description:
+      name: markdown
+      sha256: ef2a1298144e3f985cc736b22e0ccdaf188b5b3970648f2d9dc13efd1d9df051
+      url: "https://pub.dev"
+    source: hosted
+    version: "7.2.2"
   meta:
     dependency: transitive
     description:

lib/htmltopdfwidgets.dart

@@ -5,3 +5,4 @@ export 'package:pdf/widgets.dart';
 
 export 'src/html_to_widgets_codec.dart';
 export 'src/htmltagstyles.dart';
+

lib/src/html_to_widgets_codec.dart

@@ -1,5 +1,7 @@
 import 'dart:async';
 
+import 'package:markdown/markdown.dart';
+
 import '../htmltopdfwidgets.dart';
 import 'html_to_widgets.dart';
 
@@ -31,6 +33,29 @@ class HTMLToPdf extends HtmlCodec {
     //convert function that convert string to dom nodes that that dom nodes will be converted
     return await widgetDecoder.convert(html);
   }
+
+  @override
+  Future<List<Widget>> convertMarkdown(String markDown,
+      {List<Font> fontFallback = const [],
+      //font resolver (font name, bold, italic) => font
+      FutureOr<Font> Function(String, bool, bool)? fontResolver,
+      String defaultFontFamily = "Roboto",
+      double defaultFontSize = 12.0,
+      //custom html tag styles
+      HtmlTagStyle tagStyle = const HtmlTagStyle()}) async {
+    // TODO: implement convertMarkdown
+    final widgetDecoder = WidgetsHTMLDecoder(
+        //font fall back if provided
+        fontFallback: [...fontFallback],
+        fontResolver: fontResolver,
+        defaultFontFamily: defaultFontFamily,
+        defaultFontSize: defaultFontSize,
+        //custom html tags style
+        customStyles: tagStyle);
+    final html = markdownToHtml(markDown);
+    //convert function that convert string to dom nodes that that dom nodes will be converted
+    return await widgetDecoder.convert(html);
+  }
 }
 
 // Define an abstract class named HtmlCodec.
@@ -45,4 +70,8 @@ abstract class HtmlCodec {
       {List<Font> fontFallback = const [],
       FutureOr<Font> Function(String, bool, bool)? fontResolver,
       HtmlTagStyle tagStyle = const HtmlTagStyle()});
+  Future<List<Widget>> convertMarkdown(String markDown,
+      {List<Font> fontFallback = const [],
+      FutureOr<Font> Function(String, bool, bool)? fontResolver,
+      HtmlTagStyle tagStyle = const HtmlTagStyle()});
 }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: htmltopdfwidgets
 description: Htmlt to pdf widgets library convert html text to pdf widgets
-version: 1.0.4
+version: 1.0.5
 homepage: https://github.com/alihassan143/htmltopdfwidgets
 
 environment:
@@ -10,6 +10,7 @@ dependencies:
   pdf: ">=3.11.1 <4.0.0"
   html: ">=0.15.4 <1.0.0"
   http: ">=1.2.2 <2.0.0"
+  markdown: ^7.2.2
 
 dev_dependencies:
   flutter_lints: ^4.0.0

test/htmltopdfwidgets_test.dart

@@ -20,6 +20,7 @@ import 'package:htmltopdfwidgets/htmltopdfwidgets.dart';
 import 'package:test/test.dart';
 
 late Document pdf;
+late Document marDownPdf;
 
 void main() {
   const htmlText = '''  <h1>Heading Example</h1>
@@ -52,6 +53,7 @@ void main() {
     Document.debug = true;
     RichText.debug = true;
     pdf = Document();
+    marDownPdf = Document();
   });
 
   test('convertion_test', () async {
@@ -63,8 +65,50 @@ void main() {
         }));
   });
 
+  const String markDown = """
+# Basic Markdown Demo
+---
+The Basic Markdown Demo shows the effect of the four Markdown extension sets
+on formatting basic and extended Markdown tags.
+
+## Overview
+
+The Dart [markdown](https://pub.dev/packages/markdown) package parses Markdown
+into HTML. The flutter_markdown package builds on this package using the
+abstract syntax tree generated by the parser to make a tree of widgets instead
+of HTML elements.
+
+The markdown package supports the basic block and inline Markdown syntax
+specified in the original Markdown implementation as well as a few Markdown
+extensions. The markdown package uses extension sets to make extension
+management easy. There are four pre-defined extension sets; none, Common Mark,
+GitHub Flavored, and GitHub Web. The default extension set used by the
+flutter_markdown package is GitHub Flavored.
+
+The Basic Markdown Demo shows the effect each of the pre-defined extension sets
+has on a test Markdown document with basic and extended Markdown tags. Use the
+Extension Set dropdown menu to select an extension set and view the Markdown
+widget's output.
+
+## Comments
+
+Since GitHub Flavored is the default extension set, it is the initial setting
+for the formatted Markdown view in the demo.
+""";
+
+  test('markdown_convertion_test', () async {
+    List<Widget> widgets = await HTMLToPdf().convertMarkdown(markDown);
+    marDownPdf.addPage(MultiPage(
+        maxPages: 200,
+        build: (context) {
+          return widgets;
+        }));
+  });
+
   tearDownAll(() async {
     final file = File('example.pdf');
     await file.writeAsBytes(await pdf.save());
+    final markDownfile = File('markdown_example.pdf');
+    await markDownfile.writeAsBytes(await marDownPdf.save());
   });
 }