novolis-markup / getting-started.md

Getting started

Manuscripts, markdown, mermaid

dotnetmarkdownmarkupnovolis

novolis-markup provides fluent builders for GitHub-flavored Markdown and Mermaid diagram syntax on .NET 10.

Prerequisites

.NET 10 SDK

Install

Pick one or both packages:

dotnet add package Novolis.Markup.Markdown
dotnet add package Novolis.Markup.Mermaid

Markdown quick start

using Novolis.Markup.Markdown;

var doc = new MarkdownDocument()
    .WithHeader("Hello", MarkdownHeaderLevel.H1)
    .WithParagraph(new MarkdownParagraph().WithText("Build docs in code."))
    .WithUnorderedList("First", "Second");

string markdown = doc.ToString();
string html = doc.ToHtml();

Mermaid quick start

using Novolis.Markup.Mermaid;

var flowchart = new Flowchart(Direction.LeftToRight);
var a = new Node("Start");
var b = new Node("End");
flowchart.AddNode(a);
flowchart.AddNode(b);
flowchart.AddLink(new Link(a, b));

string mermaid = flowchart.GetMermaidString();

Render the returned text with Mermaid, or display it in Avalonia via Novolis.Avalonia.Mermaid (MermaidControl).

See also