EPS.Extensions.YamlMarkdown 8.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);

The YAML markup at the top of your Markdown file must end with three dashes and a newline before your Markdown starts in order for this to work.

Example:

Title: Blog title
Description: "Blog description."
Published: 10/3/2019
Updated: 05/07/2020
Keywords: this, that, something else
Image: https://res.cloudinary.com/endpoint-systems/image/upload/v1548616596/gae_qlaf4t.png
Categories: 
    - Category1
    - Category2
--- 

(blog post here)