StardustDL.RazorComponents.Markdown 0.0.1.20

.NET Standard 2.1
There is a newer version of this package available.
See the version list below for details.
dotnet add package StardustDL.RazorComponents.Markdown --version 0.0.1.20
NuGet\Install-Package StardustDL.RazorComponents.Markdown -Version 0.0.1.20
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="StardustDL.RazorComponents.Markdown" Version="0.0.1.20" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add StardustDL.RazorComponents.Markdown --version 0.0.1.20
#r "nuget: StardustDL.RazorComponents.Markdown, 0.0.1.20"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install StardustDL.RazorComponents.Markdown as a Cake Addin
#addin nuget:?package=StardustDL.RazorComponents.Markdown&version=0.0.1.20

// Install StardustDL.RazorComponents.Markdown as a Cake Tool
#tool nuget:?package=StardustDL.RazorComponents.Markdown&version=0.0.1.20

RazorComponents.Markdown

CI CD License downloads

Razor component for Markdown rendering.

Online demo:

Features

Most features are based on Markdig.

  • Abbreviations
  • Auto identifiers
  • Citations
  • Custom containers
  • Definition lists
  • Emphasis extras
  • Figures
  • Footers
  • Footnotes
  • GridTables
  • Mathematics
  • Media links
    • Youtube
    • Bilibili
    • Netease music
  • Pipe tables
  • Task lists
  • Diagrams, flowcharts
  • Auto links
  • Smarty pants
  • Emoji
  • Code highlighting

Usage

  1. Add the newest package on NuGet.

See https://www.nuget.org/packages/StardustDL.RazorComponents.Markdown for all versions.

dotnet add package StardustDL.RazorComponents.Markdown

For latest build, use the following source. https://sparkshine.pkgs.visualstudio.com/StardustDL/_packaging/feed/nuget/v3/index.json

  1. Add static assets to index.html.
<link rel="stylesheet" type="text/css" href="_content/StardustDL.RazorComponents.Markdown/highlight.js/github.css">
<link rel="stylesheet" type="text/css" href="_content/StardustDL.RazorComponents.Markdown/katex/katex.min.css">
<link rel="stylesheet" type="text/css" href="_content/StardustDL.RazorComponents.Markdown/css/markdown.css">

<script src="_content/StardustDL.RazorComponents.Markdown/component-min.js" type="text/javascript"></script>
<script src="_content/StardustDL.RazorComponents.Markdown/mermaid/mermaid.min.js" type="text/javascript"></script>
  1. Add services.
using StardustDL.RazorComponents.Markdown;

builder.Services.AddSingleton<IMarkdownComponentService, MarkdownComponentService>();
  1. Use the component in Razor components.
<StardustDL.RazorComponents.Markdown.MarkdownRenderer Value="@MarkdownText" Class="your class" Style="your styles"/>

Configuration

Use IMarkdownComponentService to configure.

Service.EnableCodeHighlight = true;
Service.EnableDiagrams = true;
Service.EnableMathematics = true;

If you want to customize Markdown's parser pipeline, you can inherit inherit MarkdownComponentService and override the method GetPipeline().

If you want to customize the all things, you can inherit inherit MarkdownComponentService and override the method RenderHTML(string).

Preview

Here are some screenshots from the demo project.

Code with highlighting

Extensions

Mathematics

Diagram

Dependencies

License

Apache-2.0

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.1
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.0.3.28 1,149 7/9/2021
0.0.3.26 297 5/30/2021
0.0.3.25 486 3/4/2021
0.0.2.24 1,429 11/11/2020
0.0.2 309 11/11/2020
0.0.1.22 1,203 9/12/2020
0.0.1.20 463 7/25/2020
0.0.1.17 470 7/8/2020
0.0.1.2-preview 338 6/12/2020