StardustDL.RazorComponents.Markdown 0.0.1.17

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.17

NuGet\Install-Package StardustDL.RazorComponents.Markdown -Version 0.0.1.17

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.17" />

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.17

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

#r "nuget: StardustDL.RazorComponents.Markdown, 0.0.1.17"

#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.

// Install StardustDL.RazorComponents.Markdown as a Cake Addin
#addin nuget:?package=StardustDL.RazorComponents.Markdown&version=0.0.1.17

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

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

RazorComponents.Markdown

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

Add the newest package on NuGet.

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

dotnet add package StardustDL.RazorComponents.Markdown --version <version>

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

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>

Add services.

using StardustDL.RazorComponents.Markdown;

builder.Services.AddSingleton<IMarkdownComponentService, MarkdownComponentService>();

Use the component in Razor components.

<StardustDL.RazorComponents.Markdown.MarkdownRenderer Value="@MarkdownText" />

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().