QuestPDF.Markdown 1.0.0

QuestPDF.Markdown

QuestPDF.Markdown allows rendering markdown into a QuestPDF document using the markdig parser.

Usage

var text = 
@"# Hello, world!
*Greetings* from **markdown**!
> Hello, back!";

var document = Document.Create(container =>
{
    container.Page(page =>
    {
        page.Margin(20);
        page.Content().Markdown(text);
    });
});

What's supported?

The aim of this library is to support all basic markdown functionality and some of the extensions supported by markdig.

Currently the following features are supported:

• Headings
• Block quotes
• Code blocks
• Lists (ordered and unordered)
• Emphasis (bold, italic)
• Task lists
• Extra emphasis (subscript, superscript, strikethrough, marked, inserted)
• Tables

Support for the following extensions will be added in the future:

• Images
• Footnotes

Support for the following extensions is not planned:

• Raw HTML
• Math blocks
• Diagrams

Contributing

To quickly test changes made in the library, you can make use of the excellent QuestPDF previewer in combination with the QuestPDF.Markdown.Tests project and dotnet watch

To render the test markdown file in the previewer, run the following command in the root directory of the repository:

dotnet watch test --project ./tests/QuestPDF.Markdown.Tests -- --filter Name=Render

To render the test markdown file in the previewer with additional background colors and margins, run the following command in the root directory of the repository:

dotnet watch test --project ./tests/QuestPDF.Markdown.Tests -- --filter Name=RenderDebug

Any changes made to the MarkdownRenderer class will be automatically reflected in the previewer.