Markdown2Pdf 0.5.1

<p align="center"> <a href="https://www.nuget.org/packages/Markdown2Pdf" target="_blank"> <img alt="Nuget" src="https://img.shields.io/nuget/v/Markdown2Pdf"> </a>

<a href="https://github.com/Flayms/Markdown2Pdf/actions/workflows/build-and-release.yml" target="_blank"> <img src="https://github.com/Flayms/Markdown2Pdf/actions/workflows/build-and-release.yml/badge.svg?event=workflow_dispatch" alt="Build and Release" /> </a> </p>

<h1 align="center"> Markdown2Pdf</h1>

<p align="center"> <img src="./assets/md2pdf.svg" alt="Logo" Width=128px/> <br> </p>

.NET library for converting Markdown to PDF. Uses Markdig for converting markdown to html and then Puppeteer Sharp to convert that output to PDF. For a cross-platform console-application checkout Markdown2Pdf.Console.

A demo can be found here!

Usage

var converter = new Markdown2PdfConverter();
converter.Convert("README.md");

Options

To further specify the conversion process you can pass Markdown2PdfOptions to the converter:

var options = var options = new Markdown2PdfOptions {
  HeaderUrl = "header.html",
  FooterUrl = "footer.html",
  DocumentTitle = "Example PDF",
};
var converter = new Markdown2PdfConverter(options);

Modules

This library uses node_modules packages. By default they're loaded over a CDN like https://cdn.jsdelivr.net.

You can also use a local installation of them by running the script Init.ps1 and setting Markdown2PdfOptions.ModuleOptions to ModuleOptions.Global.

Note: For this you need to have npm installed and added to PATH.

Alternatively you can also install the packages from the script manually and configure a custom installation path with ModuleOptions.FromLocalPath().

Used Modules

• MathJax: Latex-Math rendering
• Mermaid: Diagrams
• github-markdown-css: Github-Theme
• latex-css: Latex-Theme