Skip to content

Commit 4053906

Browse files
committed
docs(README): image loading docs
1 parent 9fe2e65 commit 4053906

File tree

1 file changed

+6
-10
lines changed

1 file changed

+6
-10
lines changed

README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,9 @@ It supports **real-time rendering** of Markdown content, so it's ideal for appli
2323
- 🔗 **Hyperlink support**: Clickable links with customizable behavior
2424
- 📊 **Table support**: Render tables with proper formatting
2525
- 📜 **Code block syntax highlighting**: Supports multiple languages with [ColorCode](https://github.com/CommunityToolkit/ColorCode-Universal)
26-
- 🖼️ **Image support**: Load images asynchronously with [AsyncImageLoader.Avalonia](https://github.com/AvaloniaUtils/AsyncImageLoader.Avalonia)
26+
- 🖼️ **Image support**: Load online, local even `avares` images asynchronously
2727
- ✍️ **Selectable text**: Text can be selected across different Markdown elements
2828

29-
> [!NOTE]
30-
> There is a bug when selecting text inside an inline that holds a `InlineUIElement`,
31-
> causing the selection is offset by 1 character after each `InlineUIElement`.
32-
> This bug is Avalonia's, and they set all related classes as `internal`,
33-
> so I can do nothing with it.
34-
3529
> [!NOTE]
3630
> This library currently only supports `Append` and `Clear` operations on the Markdown content, which is enough for LLM streaming scenarios.
3731
@@ -47,6 +41,9 @@ It supports **real-time rendering** of Markdown content, so it's ideal for appli
4741
- [x] Image support
4842
- [x] Bitmap
4943
- [x] SVG
44+
- [x] Online images
45+
- [x] Local images
46+
- [x] `avarse` images
5047
- [x] Selectable text across elements
5148
- [ ] LaTeX support
5249
- [ ] HTML rendering
@@ -112,6 +109,8 @@ markdownBuilder.Append("\n\nThis is a **live** Markdown viewer for Avalonia appl
112109
markdownBuilder.Clear();
113110
```
114111

112+
If you want to load local images with relative paths, you can set the `MarkdownRenderer.ImageBasePath` property.
113+
115114
---
116115

117116
## 🪄 Style Customization
@@ -146,6 +145,3 @@ Distributed under the Apache 2.0 License. See [LICENSE](LICENSE) for more inform
146145
- Syntax highlighting for code blocks
147146
- Source repo: https://github.com/CommunityToolkit/ColorCode-Universal
148147

149-
---
150-
151-
<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 commit comments

Comments
 (0)