huypanha
/
flutter-quill
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(readme): use Github admonitions in Markdown blockquotes

Browse Source
pull/1996/head
Ellet 9 months ago committed by GitHub
parent 6ca188dfc1
commit c373876c7f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 1 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 5
      README.md

5
README.md
Unescape View File

@ -42,6 +42,7 @@ Check out our [Youtube Playlist] or [Code Introduction](./doc/code_introduction.
to take a detailed walkthrough of the code base. to take a detailed walkthrough of the code base.
You can join our [Slack Group] for discussion. You can join our [Slack Group] for discussion.
> [!NOTE]
> If you are viewing this page from [pub.dev](https://pub.dev/) page, then you > If you are viewing this page from [pub.dev](https://pub.dev/) page, then you
> might have some issues with opening some links, open it in the GitHub repo instead. > might have some issues with opening some links, open it in the GitHub repo instead.
@ -97,6 +98,7 @@ dependencies:
ref: v<latest-version-here> ref: v<latest-version-here>
``` ```
> [!TIP]
> Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement > Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement
> of the library. > of the library.
> Your input and insights are valuable in shaping a stable and reliable version for all the developers. Thank you for > Your input and insights are valuable in shaping a stable and reliable version for all the developers. Thank you for
@ -114,6 +116,7 @@ Before using the package, we must inform you the package uses the following plug
All of them don't require any platform-specific setup. All of them don't require any platform-specific setup.
> [!NOTE]
> Starting from Flutter Quill `9.4.x`, [super_clipboard](https://pub.dev/packages/super_clipboard) has been moved > Starting from Flutter Quill `9.4.x`, [super_clipboard](https://pub.dev/packages/super_clipboard) has been moved
> to [FlutterQuill Extensions], to use rich text pasting, support pasting images, and gif files from external apps or websites, take a look > to [FlutterQuill Extensions], to use rich text pasting, support pasting images, and gif files from external apps or websites, take a look
> at `flutter_quill_extensions` Readme. > at `flutter_quill_extensions` Readme.
@ -271,7 +274,7 @@ You have two options:
Typescript/Javascript package. Typescript/Javascript package.
this package doesn't convert the HTML back to Quill Delta as far as we know this package doesn't convert the HTML back to Quill Delta as far as we know
> [!CAUTION]
> **Converting to Delta from Markdown and HTML is highly experimental and shouldn't be used for production applications**, while the current implementation is far from perfect, it could improved a lot however **it will likely not work as expected**, due to differences between HTML and Delta, see this [comment](https://github.com/slab/quill/issues/1551#issuecomment-311458570) for more info.<br> > **Converting to Delta from Markdown and HTML is highly experimental and shouldn't be used for production applications**, while the current implementation is far from perfect, it could improved a lot however **it will likely not work as expected**, due to differences between HTML and Delta, see this [comment](https://github.com/slab/quill/issues/1551#issuecomment-311458570) for more info.<br>
> We use it **internally** as it is more suitable for our specific use case, copying content from external websites and pasting it into the editor > We use it **internally** as it is more suitable for our specific use case, copying content from external websites and pasting it into the editor
previously breaks the styles, while the current implementation is not ready, it provides a better user experience and doesn't have many downsides. previously breaks the styles, while the current implementation is not ready, it provides a better user experience and doesn't have many downsides.

Write Preview
Loading…
Cancel
Save