leafpress 0.8.1

Convert MkDocs sites to PDF, Word, HTML, ODT, EPUB, and Markdown documents with branding

LeafPress

Convert MkDocs sites to PDF, Word, HTML, ODT, EPUB, and Markdown documents with branding.

Documentation · GitHub · PyPI

Features

• Generate PDF, DOCX, HTML, ODT, EPUB, and Markdown output from any MkDocs project
• Document import — convert Word (.docx), PowerPoint (.pptx), and Excel (.xlsx) files to Markdown, including batch import (leafpress import *.docx *.pptx *.xlsx)
• Monorepo support — combine multiple MkDocs projects into a single document with per-project metadata overrides
• Mermaid diagrams — fenced mermaid code blocks rendered as inline SVGs
• Diagram fetching — pull diagrams from URLs and Lucidchart API with caching
• Cover page, table of contents, branded footer, and watermark overlay
• Logo, colors, and metadata via a simple leafpress.yml config
• Git version info (tag, branch, commit) embedded in output — package version auto-detected from pyproject.toml, package.json, Cargo.toml, and more
• Convert from local paths or remote git URLs (including monorepo git URL projects)
• Actionable error messages — rendering failures show specific fixes (missing libraries, unsupported image formats)
• leafpress doctor — diagnose your environment and optional dependencies
• Desktop UI — macOS/Linux/Windows menu bar app
• CI-friendly — configure entirely via LEAFPRESS_* environment variables

Installation

# Base install (DOCX, HTML, ODT, EPUB output + document import)
uv add leafpress
pip install leafpress

# With PDF output (WeasyPrint)
uv add 'leafpress[pdf]'
pip install 'leafpress[pdf]'

# With desktop UI (PyQt6)
uv add 'leafpress[ui]'
pip install 'leafpress[ui]'

# Everything
uv add 'leafpress[all]'
pip install 'leafpress[all]'

WeasyPrint requires system libraries on Linux — see Installation docs for details. Run leafpress doctor to check your environment.

Quick Start

# Generate a starter branding config
leafpress init

# Convert to PDF (auto-detects project in current directory)
leafpress convert

# Convert to PDF + DOCX with branding
leafpress convert /path/to/project -f both -c leafpress.yml

# Convert to EPUB, HTML, ODT, or consolidated Markdown
leafpress convert /path/to/project -f epub
leafpress convert /path/to/project -f html
leafpress convert /path/to/project -f odt
leafpress convert /path/to/project -f markdown

# Convert to all formats (PDF, DOCX, HTML, ODT, EPUB, Markdown)
leafpress convert /path/to/project -f all -c leafpress.yml

# Convert from a remote git repo
leafpress convert https://github.com/org/repo -b main -f pdf

# Import Word, PowerPoint, or Excel documents to Markdown
leafpress import report.docx
leafpress import deck.pptx
leafpress import data.xlsx
leafpress import *.docx *.pptx *.xlsx -o docs/

# Check your environment
leafpress doctor

# Show site info (pages, nav, git status)
leafpress info /path/to/project

Desktop UI

# Launch menu bar / system tray app
leafpress ui

# Open the window immediately on launch
leafpress ui --show

On macOS, LeafPress lives in the menu bar (not the Dock). Click the icon to open the conversion window. Supports all the same options as the CLI, including "Open after conversion".

Requires the [ui] extra: pip install 'leafpress[ui]'

CI / GitHub Actions

LeafPress can be configured entirely via environment variables — no leafpress.yml needed.

jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install WeasyPrint system dependencies
        run: sudo apt-get install -y libpango-1.0-0 libharfbuzz0b libpangoft2-1.0-0

      - name: Install leafpress
        run: pip install 'leafpress[pdf]'

      - name: Convert docs to PDF
        env:
          LEAFPRESS_COMPANY_NAME: ${{ vars.COMPANY_NAME }}
          LEAFPRESS_PROJECT_NAME: My Project
          LEAFPRESS_PRIMARY_COLOR: "#1a73e8"
        run: leafpress convert . -f pdf -o dist/

      - name: Upload artifact
        uses: actions/upload-artifact@v4
        with:
          name: documentation
          path: dist/*.pdf

You can also place a .env file in your project root — LeafPress loads it automatically. Shell environment variables always take priority over .env values.

See CI / GitHub Actions docs for the full environment variable reference.

Branding Configuration

Create leafpress.yml in your project root (or run leafpress init):

company_name: "Acme Corp"
project_name: "Platform Docs"
logo_path: "./logo.png"         # local path or https:// URL
subtitle: "Internal Documentation"
author: "Engineering Team"
primary_color: "#1a73e8"        # 6-digit hex
accent_color: "#ffffff"

footer:
  include_tag: true
  include_date: true
  include_commit: true
  include_branch: false
  custom_text: "Confidential"

pdf:
  page_size: "A4"
  margin_top: "25mm"
  margin_bottom: "25mm"
  margin_left: "20mm"
  margin_right: "20mm"

Development

uv sync --group dev
uv run pytest tests/ -v
uv run ruff check src/

Installing globally from a local checkout

LeafPress requires Python 3.13+. To install as a standalone tool from your local repo:

uv tool install '/path/to/leafpress[all]' --force --python 3.13

If Python 3.13 isn't installed yet, uv can fetch it automatically:

uv python install 3.13
uv tool install '/path/to/leafpress[all]' --force --python 3.13

To update after making local changes, uninstall first to avoid caching:

uv tool uninstall leafpress
uv tool install '/path/to/leafpress[all]' --python 3.13

After installation, leafpress is available globally — run leafpress ui --show from anywhere.