Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
update README
  • Loading branch information
kuzmins committed Jun 11, 2025
commit a38eb38b9e9219ac3d79789a6695f42d344f1145
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@

This README covers configuration steps for Blazor Server and Blazor WebAssembly. For images of how the markup component looks like in the browser go to the [README of samples](/samples).

## Getting started
## 📘 Documentation
- 🌐 [MudBlazor.Markdown](https://github.com/MyNihongo/MudBlazor.Markdown/wiki/) - Wiki page
- ⚡ [Try.MudBlazor.com](https://try.mudblazor.com/) - Interactive playground

## 🚀 Getting started
> NB! MudBlazor does not work well with the static SSR format because some code is executed in `OnAfterRender` or `OnAfterRenderAsync` that is not invoked by default.
> Specify `@rendermode="InteractiveServer"` on the markdown component to make it work (e.g. `<MudMarkdown @rendermode="InteractiveServer" Value="some markdown here" />`)

Expand Down Expand Up @@ -56,7 +60,7 @@ builder.Services.AddMudMarkdownServices();
// NB! MauiClipboardService is just an example
builder.Services.AddMudMarkdownClipboardService<MauiClipboardService>();
```
## Using the component
## 💻 Example Usage
```razor
<MudText Typo="Typo.h3">My markdown</MudText>
<MudMarkdown Value="@Value" />
Expand Down