friebetill / delta_markdown Goto Github PK

View Code? Open in Web Editor NEW

This project forked from kolja-esders/notus_markdown

22.0 3.0 38.0 10.09 MB

A Delta Markdown converter in Dart

Home Page: https://pub.dev/packages/delta_markdown

License: BSD 3-Clause "New" or "Revised" License

Dart 100.00%

delta_markdown's Introduction

A portable Markdown library written in Dart. It can convert between Markdown and Delta.

The converter is not ready for production

Usage

import 'package:delta_markdown/delta_markdown.dart';

void main() {
  const markdown = 'Hello **Markdown**';
  print(markdownToDelta(markdown));

  const delta = r'[{"insert":"Hello "},{"insert":"Markdown","attributes":{"bold":true}},{"insert":"\n"}]';
  print(deltaToMarkdown(delta));
}

Supports

Currently, these elements are supported:

Bold
Italic
Link
Blockquote
Header
List
Code Block
Image
Horizontal Rule

Does not support the following elements, because Markdown does not support them:

Background Color
Color
Font
Size
Strikethrough
Superscript/Subscript
Underline
Text Alignment
Text Direction
Formula
Video

Does not support the following elements, because flutter_quill does not support them:

Inline Code

Known limits

Support for these elements must be implemented:

Indent

There are only a few tests so far, so the functionality is not yet guaranteed in complex cases.

delta_markdown's People

Contributors

Stargazers

Watchers

delta_markdown's Issues

Issues with new lines

Thank you very much for this great tool. I noticed an issue with new lines handling

In markdown new lines must be specified with 2 (or more) consecutive lines. so one \n in quill should be transformed into two \n. and 1 \n in markdown should be ignored and more than that should result in only a single \n.

deltaToMarkdown

[{"insert":"line 1line 2\\nline 3\\n"}]

expected:

line 1line 2

line3

actual:

line 1line 2
line 3

markdownToDelta

line 1
line 2

line 3

expected:

[{"insert":"line 1line 2\\nline3\\n"}]

actual:

[{"insert":"line 1\\nline 2\\nline 3\\n"}]

Support inline code

Regarding flutter_quill 2.5.0 now support inline code, any chance consider supporting inline code?

I'd love to make PR but I don't know where to start, a hint/guide would be appreciated.

Does not support flutter_quill >3.4.4

Looks like flutter_quill had a breaking change in the way they export stuff (models etc are no longer exposed)
So to use delta_markdown we are having to cap flutter_quill to 3.4.4 for now

package update than show issue flutter_quill: ^3.0.0

Because delta_markdown 0.3.0 depends on flutter_quill ^2.0.0 and no versions of delta_markdown match >0.3.0 <0.4.0, delta_markdown ^0.3.0 requires flutter_quill ^2.0.0.
So, because lms_teacher depends on both delta_markdown ^0.3.0 and flutter_quill ^3.0.0, version solving failed.
pub get failed (1; So, because lms_teacher depends on both delta_markdown ^0.3.0 and flutter_quill ^3.0.0, version solving failed.)
Process finished with exit code 1

  delta_markdown:
    git: 
      url: [email protected]:harkairt/delta_markdown.git