Skip to content

Repository files navigation

Novolis

novolis-markup

Manuscripts, markdown, mermaid
Manuscript, markdown, and Mermaid markup pipelines.

docs merge packages org

Docs · https://nuget.pkg.github.com/Novolis-Platform/index.json · Org landing · Governance


GitHub Packages shows this repository README on every package page (upstream limitation). Open the package README for install and quick start — embedded in each .nupkg and linked below.

Published packages

Package Install Package README
Novolis.Markup.Manuscript dotnet add package Novolis.Markup.Manuscript README
Novolis.Markup.Markdown dotnet add package Novolis.Markup.Markdown README
Novolis.Markup.Markdown.Rendering dotnet add package Novolis.Markup.Markdown.Rendering README
Novolis.Markup.Markdown.Documents dotnet add package Novolis.Markup.Markdown.Documents README
Novolis.Markup.Mermaid dotnet add package Novolis.Markup.Mermaid README
Novolis.Markup.Mermaid.Rendering dotnet add package Novolis.Markup.Mermaid.Rendering README

For NuGet.org and Visual Studio, the embedded README.md inside each package is authoritative.

novolis-markup

Programmatic Markdown, Mermaid, and manuscript tooling for .NET — migrated from Frank.Markdown and Frank.Mermaid (wave 10).

Packages

Package Description
Novolis.Markup.Markdown Fluent GitHub-flavored Markdown document builder
Novolis.Markup.Markdown.Rendering Themed HTML export via Novolis Markdown
Novolis.Markup.Markdown.Documents Fluent Markdown → PagedDocument / PDF via Documents.Skia
Novolis.Markup.Mermaid Fluent Mermaid diagram syntax builder (flowchart, sequence, gantt, …)
Novolis.Markup.Mermaid.Rendering Headless Mermaid SVG/PNG export (ToSvg / ToPng on IMermaidable)
Novolis.Markup.Manuscript Chapter metadata, content catalog, diagnostics, book/reference PDF export

Avalonia editor and preview controls live in novolis-avalonia as Novolis.Avalonia.Markdown and Novolis.Avalonia.Mermaid.

Reflection-based class diagrams remain in Novolis.CodeGen.Reflection.ClassDiagram (novolis-codegen).

Install

dotnet add package Novolis.Markup.Markdown
dotnet add package Novolis.Markup.Manuscript

Quick start

using Novolis.Markup.Markdown;

var doc = new MarkdownDocument()
    .WithHeader("Release notes", MarkdownHeaderLevel.H1)
    .WithAlert("Breaking change.", MarkdownAlertLevel.Warning);

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

Manuscript workspace (Books Mobile / Writer Studio):

using Novolis.Markup.Manuscript;

if (ManuscriptWorkspace.TryOpen(startDir, out var workspace) && workspace is not null)
{
    var series = workspace.Catalog.Load(workspace.ContentRoot);
    var issues = ManuscriptDoctor.Diagnose(workspace.ContentRoot);
}

Build

dotnet build Novolis.Markup.slnx
dotnet test Novolis.Markup.slnx

Documentation

Related repos

Repo Role
novolis-avalonia Markdown/Mermaid UI controls
novolis-apps Books Mobile, Books Writer Studio consumers
novolis-codegen Reflection class diagrams

About

Manuscript, markdown, and Mermaid markup libraries for Novolis.

Topics

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages