Markdown2Pdf 1.2.0

<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();
var resultPath = await converter.Convert("README.md");

An enumeration of markdown files can also be passed to the converter, combining them into one PDF.

Options

To further specify the conversion process, pass Markdown2PdfOptions to the converter:

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

Header and Footer

With the Markdown2PdfOptions.HeaderUrl and Markdown2PdfOptions.FooterUrl options a path to a local file containing html for the Header / Footer can be set.
Html-elements with the classes date, title, document-title, url, pageNumber will get their content replaced based on the information. Note that document-title can be set with the option Markdown2PdfOptions.DocumentTitle.

Custom Style

Custom CSS can be set with the Markdown2PdfOptions.CustomCss option. Example adding pagebreaks:

options.CustomCss = "<style>h1, h2, h3 { page-break-before: always; }</style>";

Modules

This library uses node_modules packages. By default they're loaded over the CDN they're hosted on e.g. https://cdn.jsdelivr.net.

You can also use a local installation by installing the following packages and setting Markdown2PdfOptions.ModuleOptions to ModuleOptions.FromLocalPath():

npm i mathjax@3
npm i mermaid@10.2.3
npm i @highlightjs/cdn-assets@11.9.0
npm i github-markdown-css
npm i latex.css

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

Further modification

To get more control over the HTML generation (e.g. to add your own JS-Scripts), modify the converter.ContentTemplate.