StardustDL.RazorComponents.Markdown 0.0.3.28

.NET 5.0
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.
dotnet add package StardustDL.RazorComponents.Markdown --version 0.0.3.28
<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
#r "nuget: StardustDL.RazorComponents.Markdown, 0.0.3.28"
#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.3.28

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

RazorComponents.Markdown

CI CD License downloads

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

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
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 862 7/9/2021
0.0.3.26 237 5/30/2021
0.0.3.25 421 3/4/2021
0.0.2.24 1,224 11/11/2020
0.0.2 248 11/11/2020
0.0.1.22 1,122 9/12/2020
0.0.1.20 401 7/25/2020
0.0.1.17 413 7/8/2020
0.0.1.2-preview 326 6/12/2020