From 97a08b82b7f6517e25d4b9846eab0adb24972b38 Mon Sep 17 00:00:00 2001 From: Ellet Date: Fri, 14 Jun 2024 12:47:47 +0300 Subject: [PATCH] docs: improve README.md --- README.md | 136 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 89 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index e391b51a..1412bef4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Flutter Quill

- + Flutter Quill

A rich text editor for Flutter

@@ -12,14 +12,23 @@ [![Watch on GitHub][github-forks-badge]][github-forks-link] [license-badge]: https://img.shields.io/github/license/singerdmx/flutter-quill.svg?style=for-the-badge + [license-link]: ./LICENSE + [prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge + [prs-link]: https://github.com/singerdmx/flutter-quill/issues + [github-watch-badge]: https://img.shields.io/github/watchers/singerdmx/flutter-quill.svg?style=for-the-badge&logo=github&logoColor=ffffff + [github-watch-link]: https://github.com/singerdmx/flutter-quill/watchers + [github-star-badge]: https://img.shields.io/github/stars/singerdmx/flutter-quill.svg?style=for-the-badge&logo=github&logoColor=ffffff + [github-star-link]: https://github.com/singerdmx/flutter-quill/stargazers + [github-forks-badge]: https://img.shields.io/github/forks/singerdmx/flutter-quill.svg?style=for-the-badge&logo=github&logoColor=ffffff + [github-forks-link]: https://github.com/singerdmx/flutter-quill/network/members --- @@ -27,35 +36,36 @@ FlutterQuill is a rich text editor and a [Quill] component for [Flutter]. This library is a WYSIWYG (What You See Is What You Get) editor built -for the modern Android, iOS, +for the modern Android, iOS, web and desktop platforms. Check out our [Youtube Playlist] or [Code Introduction](./doc/code_introduction.md) to take a detailed walkthrough of the code base. You can join our [Slack Group] for discussion. > 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. ## Table of contents + - [Flutter Quill](#flutter-quill) - - [Table of contents](#table-of-contents) - - [Screenshots](#screenshots) - - [Installation](#installation) - - [Platform Specific Configurations](#platform-specific-configurations) - - [Usage](#usage) - - [Migration](#migration) - - [Input / Output](#input--output) - - [Links](#links) - - [Configurations](#configurations) - - [Links](#links-1) - - [Font Family](#font-family) - - [Embed Blocks](#embed-blocks) - - [Using the embed blocks from `flutter_quill_extensions`](#using-the-embed-blocks-from-flutter_quill_extensions) - - [Links](#links-2) - - [Conversion to HTML](#conversion-to-html) - - [Translation](#translation) - - [Testing](#testing) - - [Contributors](#contributors) + - [Table of contents](#table-of-contents) + - [Screenshots](#screenshots) + - [Installation](#installation) + - [Platform Specific Configurations](#platform-specific-configurations) + - [Usage](#usage) + - [Migration](#migration) + - [Input / Output](#input--output) + - [Links](#links) + - [Configurations](#configurations) + - [Links](#links-1) + - [Font Family](#font-family) + - [Embed Blocks](#embed-blocks) + - [Using the embed blocks from `flutter_quill_extensions`](#using-the-embed-blocks-from-flutter_quill_extensions) + - [Links](#links-2) + - [Conversion to HTML](#conversion-to-html) + - [Translation](#translation) + - [Testing](#testing) + - [Contributors](#contributors) ## Screenshots @@ -86,22 +96,27 @@ dependencies: git: https://github.com/singerdmx/flutter-quill.git ``` -> Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement of the library. -> Your input and insights are valuable in shaping a stable and reliable version for all the developers. Thank you for being part of the open-source community! +> Using the latest version and reporting any issues you encounter on GitHub will greatly contribute to the improvement +> of the library. +> Your input and insights are valuable in shaping a stable and reliable version for all the developers. Thank you for +> being part of the open-source community! > ## Platform Specific Configurations -Before using the package, we must inform you the package use the following plugins: +Before using the package, we must inform you the package uses the following plugins: + ``` url_launcher flutter_keyboard_visibility device_info_plus ``` -All of them doesn't require any platform specific setup. +All of them don't require any platform-specific setup. -> 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 features, support pasting images, gif files, take a look at `flutter_quill_extensions` Readme. +> 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 features, support pasting images, gif files, take a look +> at `flutter_quill_extensions` Readme. ## Usage @@ -143,6 +158,7 @@ in most cases, it's better to. Check out [Sample Page] for more advanced usage. ## Migration + Starting from version `8.0.0` We have added [Migration Guide](/doc/migration.md) for migration from different versions @@ -170,7 +186,7 @@ final json = jsonEncode(_controller.document.toDelta().toJson()); You can then write this to storage. -To open a FlutterQuill editor with an existing JSON representation that you've previously stored, +To open a FlutterQuill editor with an existing JSON representation that you've previously stored, you can do something like this: ```dart @@ -194,6 +210,7 @@ The `QuillToolbar` and `QuillEditor` widgets let you customize a lot of things [Sample Page] provides sample code for advanced usage and configuration. ### Links + - [Using Custom App Widget](./doc/configurations/using_custom_app_widget.md) - [Localizations Setup](./doc/configurations/localizations_setup.md) - [Font Size](./doc/configurations/font_size.md) @@ -202,19 +219,27 @@ The `QuillToolbar` and `QuillEditor` widgets let you customize a lot of things ### Font Family -To use your own fonts, update your [assets folder](./example/assets/fonts) and pass in `fontFamilyValues`. -More details on [this commit](https://github.com/singerdmx/flutter-quill/commit/71d06f6b7be1b7b6dba2ea48e09fed0d7ff8bbaa), -[this article](https://stackoverflow.com/questions/55075834/fontfamily-property-not-working-properly-in-flutter) and [this](https://www.flutterbeads.com/change-font-family-flutter/). +To use your own fonts, update your [Assets](./example/assets/fonts) folder and pass in `fontFamilyValues`. +More details +on [this commit](https://github.com/singerdmx/flutter-quill/commit/71d06f6b7be1b7b6dba2ea48e09fed0d7ff8bbaa), +[this article](https://stackoverflow.com/questions/55075834/fontfamily-property-not-working-properly-in-flutter) +and [this](https://www.flutterbeads.com/change-font-family-flutter/). ## Embed Blocks -As of version 6.0, embed blocks are not provided by default as part of this package. Instead, this package provides an interface for all the users to provide their own implementations for embed blocks. Implementations for image, video, and formula embed blocks are proved in a separate package [`flutter_quill_extensions`](https://pub.dev/packages/flutter_quill_extensions). +As of version 6.0, embed blocks are not provided by default as part of this package. + +Instead, this package provides an interface for all the users to provide their own implementations for embed blocks. +Implementations for image, video, and +formula embed blocks are proved in a separate +package [`flutter_quill_extensions`](https://pub.dev/packages/flutter_quill_extensions). Provide a list of embed ### Using the embed blocks from `flutter_quill_extensions` -To see how to use the extension package, please take a look at the [README](./flutter_quill_extensions/README.md) of [FlutterQuill Extensions] +To see how to use the extension package, please take a look at the [README](./flutter_quill_extensions/README.md) +of [FlutterQuill Extensions] ### Links @@ -226,25 +251,30 @@ To see how to use the extension package, please take a look at the [README](./fl Having your document stored in Quill Delta format is sometimes not enough. Often you'll need to convert it to other formats such as HTML to publish it, or send an email. -**Note**: This package supports converting from HTML back to Quill delta but it's experimental and used internally when pasting HTML content from the clipboard to the Quill Editor +**Note**: This package supports converting from HTML back to Quill delta but it's experimental and used internally when +pasting HTML content from the clipboard to the Quill Editor You have two options: -1. Using [quill_html_converter](./quill_html_converter/) to convert to HTML, the package can convert the Quill delta to HTML well -(it uses [vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html)), it is just a handy extension to do it more quickly -1. Another option is to use -[vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html) to convert your document -to HTML. +1. Using [quill_html_converter](./quill_html_converter/) to convert to HTML, the package can convert the Quill delta to + HTML well + (it uses [vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html)), it is just a handy extension + to do it more quickly +2. Another option is to use + [vsc_quill_delta_to_html](https://pub.dev/packages/vsc_quill_delta_to_html) to convert your document + to HTML. This package has full support for all Quill operations—including images, videos, formulas, -tables, and mentions. + tables, and mentions. Conversion can be performed in vanilla Dart (i.e., server-side or CLI) or in Flutter. -It is a complete Dart part of the popular and mature [quill-delta-to-html](https://www.npmjs.com/package/quill-delta-to-html) -Typescript/Javascript package. + It is a complete Dart part of the popular and + mature [quill-delta-to-html](https://www.npmjs.com/package/quill-delta-to-html) + Typescript/Javascript package. this package doesn't convert the HTML back to Quill Delta as far as we know ## Translation -The package offers translations for the quill toolbar and editor, it will follow the system locale unless you set your own locale. +The package offers translations for the quill toolbar and editor, it will follow the system locale unless you set your +own locale. Open this [page](./doc/translation.md) for more info @@ -257,7 +287,7 @@ Please use [flutter_quill_test](https://pub.dev/packages/flutter_quill_test) for - Special thanks to everyone who has contributed to this project... - + Contributors
@@ -269,20 +299,32 @@ Made with [contrib.rocks](https://contrib.rocks). and contributors who put time and effort into everything including making all the libraries, tools, and the information we rely on - We are incredibly grateful to many individuals and organizations who have played a -role in the project. This includes the welcoming community, dedicated volunteers, talented developers and -contributors, and the creators of the open-source tools we rely on. + role in the project. + This includes the welcoming community, dedicated volunteers, talented developers and + contributors, and the creators of the open-source tools we rely on. We welcome all contributions! -Please follow these guidelines when contributing to the project. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.
+Please follow these guidelines when contributing to the project. +See [CONTRIBUTING.md](./CONTRIBUTING.md) for more +details. +
-The [CONTRIBUTING.md](./CONTRIBUTING.md) has development notes, if you're planning on contributing to the package, please consider reading it. +The [CONTRIBUTING.md](./CONTRIBUTING.md) has development notes, if you're planning on contributing to the package, +please consider reading it. [Quill]: https://quilljs.com/docs/formats + [Flutter]: https://github.com/flutter/flutter + [FlutterQuill]: https://pub.dev/packages/flutter_quill + [FlutterQuill Extensions]: https://pub.dev/packages/flutter_quill_extensions + [ReactQuill]: https://github.com/zenoamaro/react-quill + [Youtube Playlist]: https://youtube.com/playlist?list=PLbhaS_83B97vONkOAWGJrSXWX58et9zZ2 + [Slack Group]: https://join.slack.com/t/bulletjournal1024/shared_invite/zt-fys7t9hi-ITVU5PGDen1rNRyCjdcQ2g + [Sample Page]: https://github.com/singerdmx/flutter-quill/blob/master/example/lib/screens/quill/quill_screen.dart