StardustDL.RazorComponents.Markdown 0.0.3.25

Razor component for Markdown rendering.

Install-Package StardustDL.RazorComponents.Markdown -Version 0.0.3.25
dotnet add package StardustDL.RazorComponents.Markdown --version 0.0.3.25
<PackageReference Include="StardustDL.RazorComponents.Markdown" Version="0.0.3.25" />
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.3.25
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: StardustDL.RazorComponents.Markdown, 0.0.3.25"
For F# scripts that support #r syntax, copy this into the source code to reference the package.

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

Add the newest package on NuGet.

Visit 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

Module Install

This project is built on Modulight.

You can it by following the instructions from Usage and Use Razor Component Modules

builder.AddMarkdownModule();

Original Install

If you don't want to use the module, and want to control all resources manually, then use this.

  1. Add static assets to index.html.
<link rel="stylesheet" type="text/css" href="_content/StardustDL.RazorComponents.Markdown/prismjs/themes/prism.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>
<script src="_content/StardustDL.RazorComponents.Markdown/prismjs/components/prism-core.min.js"></script>
<script src="_content/StardustDL.RazorComponents.Markdown/prismjs/plugins/autoloader/prism-autoloader.min.js"></script>
  1. Add services.
using StardustDL.RazorComponents.Markdown;

builder.Services.AddMarkdownComponent();

Use the component

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

For custom IMarkdownComponentService, use the codes below to inject services.

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

Preview

Here are some screenshots from the demo project.

Header

Code with highlighting

Extensions

Mathematics

Diagram

Dependencies

License

Apache-2.0

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

Add the newest package on NuGet.

Visit 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

Module Install

This project is built on Modulight.

You can it by following the instructions from Usage and Use Razor Component Modules

builder.AddMarkdownModule();

Original Install

If you don't want to use the module, and want to control all resources manually, then use this.

  1. Add static assets to index.html.
<link rel="stylesheet" type="text/css" href="_content/StardustDL.RazorComponents.Markdown/prismjs/themes/prism.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>
<script src="_content/StardustDL.RazorComponents.Markdown/prismjs/components/prism-core.min.js"></script>
<script src="_content/StardustDL.RazorComponents.Markdown/prismjs/plugins/autoloader/prism-autoloader.min.js"></script>
  1. Add services.
using StardustDL.RazorComponents.Markdown;

builder.Services.AddMarkdownComponent();

Use the component

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

For custom IMarkdownComponentService, use the codes below to inject services.

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

Preview

Here are some screenshots from the demo project.

Header

Code with highlighting

Extensions

Mathematics

Diagram

Dependencies

License

Apache-2.0

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
0.0.3.25 23 3/4/2021
0.0.2.24 547 11/11/2020
0.0.2 101 11/11/2020
0.0.1.22 844 9/12/2020
0.0.1.20 231 7/25/2020
0.0.1.17 250 7/8/2020
0.0.1.2-preview 195 6/12/2020