Femur.Markdown.Renderer
0.0.31
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package Femur.Markdown.Renderer --version 0.0.31
NuGet\Install-Package Femur.Markdown.Renderer -Version 0.0.31
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="Femur.Markdown.Renderer" Version="0.0.31" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Femur.Markdown.Renderer" Version="0.0.31" />
<PackageReference Include="Femur.Markdown.Renderer" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Femur.Markdown.Renderer --version 0.0.31
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Femur.Markdown.Renderer, 0.0.31"
#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.
#:package Femur.Markdown.Renderer@0.0.31
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Femur.Markdown.Renderer&version=0.0.31
#tool nuget:?package=Femur.Markdown.Renderer&version=0.0.31
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Femur.Parsers.Markdown.Renderer
HTML renderer for Markdown Abstract Syntax Trees.
Overview
This package provides tools to render Markdown AST (Abstract Syntax Trees) produced by Femur.Parsers.Markdown to HTML. It includes a configurable HTML renderer that walks the AST and generates semantic HTML output.
Key Classes
MarkdownHtmlRenderer
Main renderer class that converts Markdown AST to HTML.
var parser = new MarkdownParser(stream);
var document = parser.Parse();
var renderer = new MarkdownHtmlRenderer();
string html = renderer.Render(document);
Features
- Walks the entire Markdown AST
- Generates semantic HTML 5 output
- Handles all CommonMark block and inline elements
- Preserves semantic meaning through appropriate HTML tags
MarkdownAstWalker
Base class for AST traversal. Provides:
- Visitor pattern implementation
- Methods for visiting each node type
- Extensibility for custom renderers
Supported Elements
Block-Level Elements
- Headings (h1-h6)
- Paragraphs
- Unordered/ordered lists
- List items
- Code blocks
- Block quotes
- Thematic breaks (horizontal rules)
Inline Elements
- Emphasis (em, strong)
- Code spans
- Links
- Images
- Line breaks
- Hard breaks
Text Processing
- Literal text
- HTML entity handling
- Special character escaping
Architecture
Rendering Pipeline
- Parse: Create AST using
Femur.Parsers.Markdown - Walk:
MarkdownAstWalkertraverses AST depth-first - Visit: For each node, renderer calls appropriate
Visit*method - Emit: Each visitor method generates corresponding HTML
- Output: Accumulated HTML is returned as string
Extension Pattern
Create custom renderers by extending MarkdownAstWalker:
public class CustomRenderer : MarkdownAstWalker
{
protected override void VisitHeading(HeadingNode node)
{
// Custom heading rendering
}
}
Usage
Basic HTML Rendering
using var stream = new FileStream("document.md", FileMode.Open);
var parser = new MarkdownParser(stream);
var document = parser.Parse();
var renderer = new MarkdownHtmlRenderer();
var html = renderer.Render(document);
Features
- ✅ Complete CommonMark element support
- ✅ Semantic HTML output
- ✅ Extensible visitor pattern
- ✅ Efficient AST traversal
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Femur.Markdown.Abstractions (>= 0.0.31)
- System.Memory (>= 4.6.3)
-
net10.0
- Femur.Markdown.Abstractions (>= 0.0.31)
-
net8.0
- Femur.Markdown.Abstractions (>= 0.0.31)
-
net9.0
- Femur.Markdown.Abstractions (>= 0.0.31)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.