CDS.Markdown
1.5.1
dotnet add package CDS.Markdown --version 1.5.1
NuGet\Install-Package CDS.Markdown -Version 1.5.1
<PackageReference Include="CDS.Markdown" Version="1.5.1" />
<PackageVersion Include="CDS.Markdown" Version="1.5.1" />
<PackageReference Include="CDS.Markdown" />
paket add CDS.Markdown --version 1.5.1
#r "nuget: CDS.Markdown, 1.5.1"
#:package CDS.Markdown@1.5.1
#addin nuget:?package=CDS.Markdown&version=1.5.1
#tool nuget:?package=CDS.Markdown&version=1.5.1
CDS.Markdown
A comprehensive .NET library for rendering and generating Markdown in WinForms applications.
Compatible with:
- .NET 8
- .NET 10
Features
- WinForms Viewer Control: Render Markdown files using Markdig and WebView2.
- Programmatic Creation: Generate Markdown dynamically using a clean Fluent API or a traditional Builder API.
- Offline-First: Embedded resources for GitHub-style CSS, Mermaid.js diagrams, and MathJax (LaTeX math) mean no internet connection is required.
Getting Started
1. Install the NuGet package:
dotnet add package CDS.Markdown
2. Viewing Markdown
Add the MarkdownViewer control to your form:
using CDS.Markdown;
// ...
var viewer = new MarkdownViewer();
await viewer.LoadMarkdownAsync("README.md");
this.Controls.Add(viewer);
3. Generating Markdown
Create structured Markdown programmatically:
using CDS.Markdown;
var markdown = new FluentMarkdownDocument()
.AddHeading("Hello, World!")
.AddParagraph("This is a **bold** statement.")
.AddBulletList(["First item", "Second item"])
.ToMarkdown();
Documentation
For full documentation, including advanced rendering features and the Builder API, please visit the GitHub Repository.
License
MIT
Contributing
Pull requests are welcome!
Repository
https://github.com/nooogle/CDS.Markdown
Attributions
<a href="https://www.flaticon.com/free-icons/markdown" title="markdown icons">Markdown icons created by brajaomar_j - Flaticon</a> <a href="https://www.flaticon.com/free-icons/right-arrow" title="right arrow icons">Right arrow icons created by hqrloveq - Flaticon</a>
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0-windows7.0 is compatible. net9.0-windows was computed. net10.0-windows was computed. net10.0-windows7.0 is compatible. |
-
net10.0-windows7.0
- Markdig (>= 1.1.3)
- Microsoft.Web.WebView2 (>= 1.0.3912.50)
-
net8.0-windows7.0
- Markdig (>= 1.1.3)
- Microsoft.Web.WebView2 (>= 1.0.3912.50)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Initial public release.