Skip to content

Commit

Permalink
docs(readme): improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EchoEllet committed Nov 11, 2024
1 parent 0c537f2 commit 5e1fa6b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ The `QuillSimpleToolbar` and `QuillEditor` widgets are both customizable.
- [🔘 Custom Toolbar buttons](./doc/configurations/custom_buttons.md)
- [🔍 Search](./doc/configurations/search.md)
- [✂️ Shortcut events](./doc/customizing_shortcuts.md)
- [🎨 Custom Toolbar](./doc/custom_toolbar.md)

### 🖋 Font Family

Expand All @@ -263,19 +264,13 @@ and [this](https://www.flutterbeads.com/change-font-family-flutter/).

The `flutter_quill` 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).

### 🛠️ 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]
Refer to the [Custom Embed Blocks](./doc/custom_embed_blocks.md) for more details.

### 🔗 Links
### 🛠️ Using the embed blocks from `flutter_quill_extensions`

- [Custom Embed Blocks](./doc/custom_embed_blocks.md)
- [Custom Toolbar](./doc/custom_toolbar.md)
The [`flutter_quill_extensions`][FlutterQuill Extensions]
package provide implementations for image and video embed blocks.

## 🔄 Delta Conversion

Expand All @@ -286,7 +281,7 @@ of [FlutterQuill Extensions]
> instead of other formats (e.g., HTML, Markdown, PDF, Microsoft Word, Google Docs, Apple Pages, XML).
>
> Converting **Delta** from/to **HTML** is not a standard feature in [Quill JS](https://github.com/slab/quill)
> or [FlutterQuill].
> or [Flutter Quill][FlutterQuill].

Available Packages for Conversion

Expand Down Expand Up @@ -319,7 +314,7 @@ The plugin [`quill_native_bridge`](https://pub.dev/packages/quill_native_bridge)
</p>

> [!IMPORTANT]
> Currently this feature is not supported on the web.
> Currently this feature is unsupported on the web.
> See [issue #1998](https://github.com/singerdmx/flutter-quill/issues/1998) and [issue #2220](https://github.com/singerdmx/flutter-quill/issues/2220)
for more details.

Expand Down
2 changes: 1 addition & 1 deletion doc/custom_embed_blocks.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Custom Embed Blocks
# 📦 Custom Embed Blocks

Sometimes you want to add some custom content inside your text, custom widgets inside them.
An example is adding
Expand Down

0 comments on commit 5e1fa6b

Please sign in to comment.