Quickstart¶

Render a file¶

markprint README.md README.pdf

Infer the output name¶

markprint README.md

This writes README.pdf.

Render a raw Markdown string¶

markprint render-string "# Hello Markprint" --output hello.pdf

Render from stdin¶

echo "# Hello from stdin" | markprint - hello.pdf

Add a theme¶

markprint README.md README.pdf --theme github

Add a profile¶

markprint report.md report.pdf --profile report --theme nord --toc

Add frontmatter¶

---
title: Architecture Report
author: William R. Astley
theme: nord
profile: report
toc: true
page_numbers: true
---

# Overview

Then run:

markprint report.md report.pdf

Use Python¶

from markprint import RenderOptions, render_pdf

render_pdf(
    markdown="# Hello

This came from Python.",
    output="hello.pdf",
    options=RenderOptions(theme="github", toc=True),
)