agent-markdown-pdf 0.2.0

Agent-friendly Markdown-to-PDF CLI with HTML preview and JSON diagnostics

mdtopdf: Agent-friendly Markdown-to-PDF CLI

中文文档

One command gives agents a controlled Markdown-to-PDF path.

---

Why it works for agents

Agents are good at writing Markdown. The problem is the handoff: PDFs exported through ad hoc paths rarely share the same style. mdtopdf gives the user a command-line interface where the style can be defined up front.

• Agent-friendly - mdtopdf --help is an interface description an agent can read.
• JSON when it matters - conversion, HTML preview, environment checks, and theme listing can return machine-readable output.
• Local files in, local files out - no browser dependency, no upload step, no remote rendering service.
• More than plain Markdown - Obsidian links, highlights, frontmatter, comments, and callouts are rendered.

Quick start

Install from PyPI:

python -m pip install agent-markdown-pdf

The PyPI distribution is agent-markdown-pdf; it installs the mdtopdf command. Do not use mdtopdf as the PyPI package name; the distribution name is intentionally different from the command name.

Use case	Name
Install from PyPI	agent-markdown-pdf
Run the CLI	mdtopdf
Import in Python	mdtopdf

Check the machine:

mdtopdf doctor --json

Convert a file:

mdtopdf convert report.md -o report.pdf --overwrite

Try the bundled visual test document:

git clone https://github.com/ABClize/mdtopdf.git
cd mdtopdf
python -m pip install -e .[dev]
mdtopdf html examples/visual-test-en.md -o visual-test-en.html --overwrite
mdtopdf convert examples/visual-test-en.md -o visual-test-en.pdf --overwrite --json

The same visual test is also available in Chinese at examples/visual-test-cn.md.

Agent workflow

The bundled agent skill lives at mdtopdf/skills/SKILL.md. Use that file when another agent needs a compact runtime guide for mdtopdf.

mdtopdf doctor --json
mdtopdf convert report.md -o report.pdf --overwrite --json

Use HTML preview when layout needs a quick look:

mdtopdf html report.md -o report.html --overwrite --json
mdtopdf convert report.md -o report.pdf --overwrite --json

convert --json returns the input path, output path, file size, theme, font check summary, warnings, and render method. If conversion fails in JSON mode, the error is structured enough for an agent to show the command, explain the likely cause, and retry after a fix.

Visual output

The gallery below is rendered from the final PDF produced by examples/visual-test-en.md. It shows the actual pages an agent can hand back to a user: headings, callouts, tables, code, math, images, Mermaid, and pagination.

Page 1	Page 2
Page 3	Page 4
Page 5	Page 6

How it works

Markdown -> markdown-it-py HTML -> theme/custom CSS -> WeasyPrint PDF

Mermaid rendering is optional. If a local mmdc command exists, Mermaid blocks render to SVG. If it is missing, conversion still succeeds and Mermaid blocks remain visible as highlighted code.

Features

Feature	Notes
JSON output	--json is available for conversion, HTML preview, doctor, and theme listing.
Environment checks	doctor --json checks Python imports, native WeasyPrint libraries, Windows DLL paths, Mermaid availability, and recommended fonts.
Local rendering	Markdown, CSS, math, Mermaid SVG generation, and PDF export stay on the machine.
HTML preview	Generate standalone HTML before PDF export for fast visual inspection.
Obsidian compatibility	Wikilinks, aliases, frontmatter hiding, comments, highlights, and typed callouts.
Document Markdown	Tables, task lists, footnotes, heading anchors, fenced code, and Pygments highlighting.
KaTeX math	Inline and block TeX render with bundled KaTeX assets, without a CDN.
Safe HTML default	Common inline document tags are allowed; unsafe raw HTML stays escaped unless opted in.
Python API	Convert Markdown strings or files from your own code.

Commands

Render a PDF:

mdtopdf convert report.md -o report.pdf
mdtopdf convert report.md -o report.pdf --overwrite

Preview HTML:

mdtopdf html report.md -o report.html --overwrite

Set document metadata and page chrome:

mdtopdf convert report.md -o report.pdf --title "Report"
mdtopdf convert report.md -o report.pdf --header "Report" --footer "Draft"
mdtopdf convert report.md -o report.pdf --no-header --no-footer

Use extra CSS or resource lookup paths:

mdtopdf convert report.md -o report.pdf --css print.css
mdtopdf convert report.md -o report.pdf --base-url assets
mdtopdf convert report.md -o report.pdf --resource-dir attachments

Custom CSS is the style extension point. Put document-specific rules in a CSS file; fonts, spacing, colors, page rules, and code block styling all live there. Use a system-installed font directly, or define @font-face for a local font file. Relative URLs in CSS are resolved from the Markdown file's base URL, so use --base-url when those assets live next to your document:

@font-face {
  font-family: "Report Sans";
  src: url("fonts/NotoSansSC-Regular.otf");
}

:root {
  font-family: "Report Sans", "Noto Sans SC", "Source Han Sans SC", sans-serif;
}

code,
pre {
  font-family: "Cascadia Code", "Liberation Mono", monospace;
}

Then pass the CSS file:

mdtopdf convert report.md -o report.pdf --css print.css --base-url .

During export, mdtopdf checks the final CSS font stacks. Missing fonts do not stop PDF generation, but they are reported in CLI warnings and in the JSON warnings field.

Return JSON:

mdtopdf --json convert report.md -o report.pdf --overwrite
mdtopdf doctor --json
mdtopdf themes list --json

Allow raw HTML only for trusted local Markdown:

mdtopdf convert trusted.md -o trusted.pdf --unsafe-html

Python API

from mdtopdf import (
    markdown_file_to_html,
    markdown_file_to_pdf,
    markdown_to_html,
    markdown_to_pdf,
)

rendered = markdown_to_html("# Report\n\n==highlight==")
print(rendered.html)

markdown_to_pdf("# Report\n\nBody", "report.pdf", title="Report", overwrite=True)
markdown_file_to_html("report.md", output_path="report.html", overwrite=True)
markdown_file_to_pdf("report.md", output_path="report.pdf", overwrite=True)

Markdown support

mdtopdf supports:

• CommonMark
• Tables
• Strikethrough
• Task lists
• Footnotes
• Heading anchors
• Fenced code blocks with Pygments highlighting
• Obsidian-style ==highlight== marks
• Obsidian-style [[target|alias]] wikilinks
• Obsidian-style %%comment%% comments outside code
• Obsidian/YAML frontmatter hiding at the start of the file
• Obsidian-style callouts such as > [!note] Title
• Safe inline HTML tags such as <br>, <kbd>, <mark>, <sup>, and <sub>
• TeX math through $inline$, $$block$$, and common amsmath environments
• Mermaid diagrams through local mmdc, when installed

Raw HTML is disabled by default except for the safe subset above. For trusted local Markdown, pass --unsafe-html.

Mermaid diagrams

Install a persistent local renderer:

npm install -g @mermaid-js/mermaid-cli

mdtopdf does not call Mermaid.ink and does not download Mermaid CLI through npx during conversion. Run mdtopdf doctor --json to check whether Mermaid rendering is available.

Platform notes

mdtopdf requires Python 3.10+ and installs its Python dependencies from PyPI: click, markdown-it-py, mdit-py-plugins, pygments, latex2mathml, matplotlib, mini-racer, and weasyprint.

WeasyPrint also needs native libraries such as Pango, GLib, and Cairo. Linux and macOS package managers usually provide them through system packages.

The default theme names Microsoft YaHei first in its CSS on every platform, including Linux. If that font is installed in the environment, WeasyPrint will use it. If it is missing, the theme falls back to PingFang SC, Noto Sans SC, Noto Sans CJK SC, Source Han Sans SC, and other available CJK fonts.

For stable CJK output in Linux containers or agent sandboxes where Microsoft YaHei is not installed, install the CJK font you want to use. Noto CJK is a practical fallback on Debian or Ubuntu:

Emoji are rendered through the system emoji font. The default theme prefers Segoe UI Emoji for emoji spans on every platform, including Linux. Windows usually provides it; Linux containers only get the same glyphs if the runtime provides that font. If Segoe UI Emoji is not available, the theme falls back to Apple Color Emoji, Noto Emoji, Noto Color Emoji, and other installed emoji fonts. Whether the final PDF keeps color emoji still depends on WeasyPrint, Pango/Cairo, and the PDF viewer.

On Debian or Ubuntu, this is a practical open-font fallback baseline:

sudo apt-get install -y fonts-noto-cjk fonts-noto-color-emoji fonts-stix fonts-dejavu-core
fc-cache -f

On Windows, install the native libraries separately. A common MSYS2 setup is:

winget install MSYS2.MSYS2

Then install Pango from an MSYS2 MINGW64 shell:

pacman -S mingw-w64-x86_64-pango

Finally, point WeasyPrint at the DLL directory from PowerShell. Adjust the path if MSYS2 is installed somewhere else:

setx WEASYPRINT_DLL_DIRECTORIES "C:\msys64\mingw64\bin"

Run this after installation. The JSON output also reports whether recommended CJK, emoji, monospace, and math fallback fonts are present:

mdtopdf doctor --json

Development

git clone https://github.com/ABClize/mdtopdf.git
cd mdtopdf
python -m pip install -e .[dev]
python -m pytest tests/ -q

Build and check the package:

python -m build
python -m twine check dist/*

License

MIT. Bundled KaTeX assets are also distributed under the MIT license; see mdtopdf/vendor/katex/LICENSE.

mdtopdf does not bundle CJK body fonts, emoji fonts, or proprietary system fonts. The default theme references local system fonts such as Microsoft YaHei, PingFang SC, Segoe UI, Segoe UI Emoji, Noto Emoji, Noto Color Emoji, and Consolas, but those font files come from the user's operating system or runtime environment.