Skip to main content

Merge Markdown files into a single PDF with Pandoc + XeLaTeX

Project description

mdfusion

Merge all Markdown files in a directory tree into a single PDF with formatting via Pandoc + XeLaTeX.


Features

  • Recursive Markdown merge: Collects and sorts all .md files under a directory (natural sort order).
  • PDF output via Pandoc + XeLaTeX: Produces a polished PDF with centered section headings and small margins.
  • Title page and metadata: Optional title page with configurable title, author, and date.
  • Config file support: Use a mdfusion.toml config file for repeatable builds.
  • Custom LaTeX header: Inject your own LaTeX via header.tex if desired.
  • Image link rewriting: Converts relative image links to absolute paths, so identically-named images in different folders don't collide.

Installation

Install via pip

pip install mdfusion

Install from source

  1. Clone this repo
  2. Install Python 3.8+ and Pandoc with XeLaTeX support
  3. Install the mdfusion package:
pip install ./mdfusion

Usage

mdfusion ROOT_DIR [OPTIONS]

Common options

  • -o, --output FILE Output PDF filename (default: <root_dir>.pdf)
  • --no-toc Omit table of contents
  • --title-page Include a title page
  • --title TITLE Set title for title page (default: directory name)
  • --author AUTHOR Set author for title page (default: OS user)
  • --pandoc-args ARGS Extra Pandoc arguments (whitespace-separated)
  • -c, --config FILE Path to a mdfusion.toml config file (default: mdfusion.toml in the current directory)

Example

mdfusion --title-page --title "My Book" --author "Jane Doe" docs/

Configuration file

You can create a mdfusion.toml file in your project directory:

[mdfusion]
root_dir = docs
output = my-book.pdf
no_toc = true
title_page = true
title = My Book
author = Jane Doe
pandoc_args = --number-sections

Then just run:

mdfusion

How it works

  • Finds and sorts all Markdown files under the root directory
  • Merges them into one file, rewriting image links to absolute paths
  • Optionally adds a YAML metadata block for title/author/date
  • Inserts page breaks between files
  • Calls Pandoc with XeLaTeX and a custom header for formatting

Testing

Run all tests with:

pytest

Author

ejuet

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdfusion-0.1.9.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdfusion-0.1.9-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file mdfusion-0.1.9.tar.gz.

File metadata

  • Download URL: mdfusion-0.1.9.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.4

File hashes

Hashes for mdfusion-0.1.9.tar.gz
Algorithm Hash digest
SHA256 a9cebb8497f79e670ceb1f4f42f5b20fd136eb45d78c1d87716b7b1c4d356330
MD5 6ecbd85280c19a73b5d024bed072ce07
BLAKE2b-256 94db12af45377a84edf726950a561ca9f46d95dc93aeb3d47dd44e7fcbf8eb18

See more details on using hashes here.

File details

Details for the file mdfusion-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: mdfusion-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 5.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.4

File hashes

Hashes for mdfusion-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 6f63ccac6ea1f20368edb6c9c5b706612b69b7617042057705cc1a443e63d654
MD5 1455b7cd1a27c211905cce10bad3c43c
BLAKE2b-256 4543b308fe6d55bb94110504b56e0a2d097065ec10d8ebc3ef8c1939b7302e8f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page