StardustDL.RazorComponents.Markdown 0.0.3.28

.NET 5.0

dotnet add package StardustDL.RazorComponents.Markdown --version 0.0.3.28

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

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

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

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

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

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

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

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

RazorComponents.Markdown

License

Razor component for Markdown rendering.

Online demo:

Features

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
Delay rendering for less CPU intensive

Usage

Add the newest package on NuGet.

dotnet add package StardustDL.RazorComponents.Markdown

Install

This project is built on Modulight.

Here are the example codes, which based on the instructions from Usage and Use Razor Component Modules. See demo for details.

WebAssembly

// in App.razor

<Modulight.Modules.Client.RazorComponents.UI.ResourceDeclare />

// in Program.cs

public static async Task Main(string[] args) 
{ 
    var builder = WebAssemblyHostBuilder.CreateDefault(args); 
    builder.RootComponents.Add<App>("app");

    builder.Services.AddModules(builder => 
    { 
        builder.UseRazorComponentClientModules().AddMarkdownModule(); 
    }); 

    builder.Services.AddTransient(sp => new HttpClient { BaseAddress = new Uri(builder.HostEnvironment.BaseAddress) }); 

    // Attention: RunAsyncWithModules
    await builder.Build().RunAsyncWithModules(); 
}

Razor Pages

// in Startup: void ConfigureServices(ISeviceCollection services)

using StardustDL.RazorComponents.Markdown;

services.AddModules(builder => {
    builder.UseRazorComponentClientModules().AddMarkdownModule();
});

// Generic hosting. (provided by package Modulight.Modules.Hosting, need to add this package)
// in Program: Task Main(string[] args)

using Microsoft.Extensions.Hosting;

await CreateHostBuilder(args).Build().RunAsyncWithModules();

Using

<StardustDL.RazorComponents.Markdown.MarkdownRenderer
    Value="@MarkdownText"
    Class="your class"
    Style="your styles"
    RenderInterval="@TimeSpan.FromSeconds(10)"/>

Parameters:

Value Raw Markdown (String)
Class class attribute
Style style attribute
RenderInterval Delay rendering interval (TimeSpan), default null for no delay.

Configuration

Use IMarkdownComponentService to configure.

Attention: The configuration will be changed in next version.

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