Skip to content

Commit 717988a

Browse files
committed
Add additional documentation
1 parent ef9f6c4 commit 717988a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,15 @@ Markdown(
128128
)
129129
```
130130

131-
**Note:** Import either `com.mikepenz.markdown.m3.Markdown` for Material 3 or
131+
> [!NOTE]
132+
> Import either `com.mikepenz.markdown.m3.Markdown` for Material 3 or
132133
`com.mikepenz.markdown.m2.Markdown` for Material 2 themed applications.
133134

135+
> [!NOTE]
136+
> By default, when the markdown `content` changes, the component will display a loading state while
137+
> parsing the new content. To keep the previous content visible during updates and avoid showing the
138+
> loading state, set `retainState` to `true`.
139+
134140
<details><summary><b>Advanced Usage</b></summary>
135141
<p>
136142

0 commit comments

Comments
 (0)