Frank.Markdown 0.1.3-preview

Frank.Markdown

A great fluent API for creating markdown documents in C#.

Installation

NuGet

Install-Package Frank.Markdown

Usage

Create a markdown document

var section1 = new MarkdownHeader("Header");
var section2 = new MarkdownHeader("Header", 2);
var items = new[] {"Item 1", "Item 2"};
var orderedList = new MarkdownOrderedList(items);
var unorderedList = new MarkdownUnorderedList(items);
var codeBlock = new MarkdownCodeBlock("var x = 1;");
var table = new MarkdownTable<MarkdownTableTestRow>(new List<MarkdownTableTestRow>
{
    new() {Name = "Name 1", Value = 1, Vector = new Vector2(1, 2), Version = new Version(1, 2, 3)},
    new() {Name = "Name 2", Value = 2, Vector = new Vector2(3, 4), Version = new Version(4, 5, 6)}
});
var alert = new MarkdownAlert("Urgent info that needs immediate user attention to avoid problems.", MarkdownAlertLevel.Warning);

var builder = new MarkdownBuilder();
    .With(section1)
    .WithHeader(section2)
    .WithOrderedList(orderedList)
    .WithUnorderedList(unorderedList)
    .WithCodeBlock(codeBlock)
    .WithTable(table)
    .WithAlert(alert);

var result = builder.ToString();

Result

# Header

## Header

1. Item 1
2. Item 2

- Item 1
- Item 2

@```
var x = 1;
@```

| Name | Value | Vector | Version |
| --- | --- | --- | --- |
| Name 1 | 1 | <1  2> | 1.2.3 |
| Name 2 | 2 | <3  4> | 4.5.6 |

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.