Novolis Docs
novolis-maui / getting-started.md

Getting started

dotnetmauimarkdownmermaidnovolis

novolis-maui provides MAUI viewers for Markdown and Mermaid that compose Novolis.Markup.*. Apps should not reimplement HTML conversion or CSP.

Prerequisites

  • .NET 10 SDK with the MAUI workload
  • GitHub Packages for Novolis.* (https://nuget.pkg.github.com/Novolis-Platform/index.json)

Install

dotnet add package Novolis.Maui.Markdown

Markdown quick start

using Novolis.Maui.Markdown;

var view = new MarkdownView
{
    Theme = MarkdownViewTheme.GitHubDark,
    Title = "notes.md",
    Markdown = "# Hello\n\nOpen a `.md` file in your host.",
};

var html = MarkdownHtml.FromMarkdown(markdown, MarkdownViewTheme.StudioDark);

Mermaid quick start

using Novolis.Maui.Mermaid;

var view = new MermaidView
{
    DiagramTheme = MermaidViewTheme.StudioDark,
    Source = "flowchart LR\n  A --> B",
};

Local validation

dotnet test d:\novolis\novolis-maui\tests\Novolis.Maui.Unit\Novolis.Maui.Unit.csproj -p:NovolisUseProjectReferences=true