MudBlazor.Markdown 0.1.1

There is a newer version of this package available.
See the version list below for details.

dotnet add package MudBlazor.Markdown --version 0.1.1

NuGet\Install-Package MudBlazor.Markdown -Version 0.1.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="MudBlazor.Markdown" Version="0.1.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="MudBlazor.Markdown" Version="0.1.1" />
                    

                            Directory.Packages.props

<PackageReference Include="MudBlazor.Markdown" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add MudBlazor.Markdown --version 0.1.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: MudBlazor.Markdown, 0.1.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package MudBlazor.Markdown@0.1.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=MudBlazor.Markdown&version=0.1.1
                    

                            Install as a Cake Addin

#tool nuget:?package=MudBlazor.Markdown&version=0.1.1
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Markdown component for MudBlazor

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

Update guide

For guidance with update errors please visit the wiki page.

Getting started

Install the NuGet package.

dotnet add package MudBlazor.Markdown

Add the following using statement in _Imports.razor.

@using MudBlazor

Add the following nodes in either App.razor or MainLayout.razor.

<MudThemeProvider />
<MudDialogProvider />
<MudSnackbarProvider />

Add the following nodes in Pages/_Host.cstml (Server) or wwwroot/index.html (WebAssembly).
In the <head> node add these CSS stylesheets.

<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" rel="stylesheet" />
<link href="_content/MudBlazor/MudBlazor.min.css" rel="stylesheet" />
<link href="_content/MudBlazor.Markdown/MudBlazor.Markdown.min.css" rel="stylesheet" />

At the bottom of the <body> node add this JS source.

<script src="_content/MudBlazor/MudBlazor.min.js"></script>
<script src="_content/MudBlazor.Markdown/MudBlazor.Markdown.min.js"></script>

public void ConfigureServices(IServiceCollection services)
{
    services.AddMudServices();
    services.AddMudMarkdownServices();
}

For the Blazor WebAssembly in the Program.cs add this method.

var builder = WebAssemblyHostBuilder.CreateDefault(args);
builder.Services.AddMudServices();
builder.Services.AddMudMarkdownServices();

Using the component

<MudText Typo="Typo.h3">My markdown</MudText>
<MudMarkdown Value="@Value" />

@code
{
    private string Value { get; } = "text *italics* and **bold**";
}

Available properties

Value - string value of the markdown text;
LinkCommand - <MudLink> components will not navigate to the provided URL, but instead invoke the command. If the property is null then <MudLink> will navigate to the link automatically (behaviour of <a>);
TableCellMinWidth - minimum width (in pixels) for a table cell. If the property is null or negative the min width is not applied;
OverrideHeaderTypo - override a Typo parameter for tags <h1>, <h2>, etc.;
OverrideLinkUrl - override a URL address for links;
CodeBlockTheme - default theme for code blocks;
Styling - override default styling.

Palette (colour) configurations

Useful links for configuring the palette:

Default theme - all CSS variables and their default values
Overview - how the theme can be configured

The <MudMarkdown> supports the palette of the MudTheme which makes styling easy (we hope). These are the colors which are used in the <MudMarkdown>:

DrawerBackground - background-color of the quoted text;
OverlayDark - background-color of the code block;
TextDisabled - border-color of the quoted text and border-color of the h1 and h2 bottom divider;
TextPrimary - regular text in the markdown;
TextSecondary - color of the quoted text;

Product	Compatible and additional computed target framework versions.
.NET	net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Markdig (>= 0.31.0)
- MudBlazor (>= 6.3.0)
net7.0
- Markdig (>= 0.31.0)
- MudBlazor (>= 6.3.0)

NuGet packages (9)

Showing the top 5 NuGet packages that depend on MudBlazor.Markdown:

Package	Downloads
MudBlazor.Extensions MudBlazor.Extensions is a small extension library for MudBlazor from https://mudblazor.com/	696.3K
Jakar.Extensions.Blazor Extensions to aid in development.	10.5K
ModelingEvolution.Ide.Blazor Package Description	6.8K
SWSharedKernel.Web Package Description	4.8K
MedbaseComponents Shared view code for Medbase projects.	2.2K

GitHub repositories (6)

Showing the top 6 popular GitHub repositories that depend on MudBlazor.Markdown:

Repository	Stars
kurrent-io/KurrentDB KurrentDB is a database that's engineered for modern software applications and event-driven architectures. Its event-native design simplifies data modeling and preserves data integrity while the integrated streaming engine solves distributed messaging challenges and ensures data consistency.	5.8K
DragoQCC/CrucibleC2 A C# Command & Control framework	1.0K
MindWorkAI/AI-Studio MindWork AI Studio is a free, independent cross-platform desktop app for local and cloud LLMs across providers, built to democratize AI access.	522
fgilde/MudBlazor.Extensions MudBlazor.Extensions from https://www.mudex.org is a small extension for MudBlazor from https://mudblazor.com	324
moonheart/mementomori-helper メメントモリ MementoMori 游戏助手 Game Assistant ゲームアシスタント	141
discord-csharp/MODiX Discord Bot handling basic moderation needs, soon implements statistics.	129

Version	Downloads	Last Updated
9.0.0	135,671	2/21/2026
9.0.0-preview.2	225	1/23/2026
8.11.0	306,114	8/6/2025
8.9.0	61,261	7/6/2025
8.7.0	83,064	6/10/2025
8.6.0	55,425	5/1/2025
8.5.1.1	18,639	4/27/2025
8.5.1	15,088	4/19/2025
8.0.0	136,319	1/25/2025
7.14.0	111,754	10/23/2024
7.8.0	55,803	9/7/2024
1.0.2	97,481	6/5/2024
1.0.1	80,559	5/31/2024
1.0.0	22,055	5/19/2024
1.0.0-preview.1	173	6/6/2024
0.1.3	115,140	12/11/2023
0.1.2	63,326	8/6/2023
0.1.1	40,975	5/27/2023
0.1.0	65,369	1/15/2023
0.0.12	65,011	8/28/2022

https://github.com/MyNihongo/MudBlazor.Markdown/releases