EPS.Extensions.YamlMarkdown
6.0.0
Install-Package EPS.Extensions.YamlMarkdown -Version 6.0.0
dotnet add package EPS.Extensions.YamlMarkdown --version 6.0.0
<PackageReference Include="EPS.Extensions.YamlMarkdown" Version="6.0.0" />
paket add EPS.Extensions.YamlMarkdown --version 6.0.0
#r "nuget: EPS.Extensions.YamlMarkdown, 6.0.0"
// Install EPS.Extensions.YamlMarkdown as a Cake Addin
#addin nuget:?package=EPS.Extensions.YamlMarkdown&version=6.0.0
// Install EPS.Extensions.YamlMarkdown as a Cake Tool
#tool nuget:?package=EPS.Extensions.YamlMarkdown&version=6.0.0
YamlMarkdown
This NuGet package combines YamlDotNet and the Markdig Markdown parsing engine and makes a dead-simple class for parsing a file or TextReader object and deserializing your YAML object type as well as giving you your content in the original Markdown and generic HTML renderings.
The Markdig plugin uses a YAML front matter extension that will parse a YAML front matter into the MarkdownDocument.
Ours treats the YAML front matter as a completely separate object to be used for other purposes (SEO metadata in our use case).
How It Works
// Article in this case is a class of metadata properties
// saved in the YAML
var parser = new YamlMarkdown<Article>();
// we get the Article object here
var article = parser.Parse("article.md");
//...and here
Console.WriteLine(parser.DataObject);
//...and the markup (separate from the YAML) here
Console.WriteLine(parser.Markdown);
//...and the parsed HTML here
Console.WriteLine(parser.Html);
Product | Versions |
---|---|
.NET | net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows |
-
net6.0
- Html2Markdown (>= 5.0.0.468)
- Markdig (>= 0.26.0)
- YamlDotNet (>= 11.2.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
.NET 6 compatibility