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
.mdfiles 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.tomlconfig file for repeatable builds. - Custom LaTeX header: Inject your own LaTeX via
header.texif 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
- Clone this repo
- Install Python 3.8+ and Pandoc with XeLaTeX support
- Install the
mdfusionpackage:
pip install ./mdfusion
Usage
mdfusion ROOT_DIR [OPTIONS]
Common options
-o, --output FILEOutput PDF filename (default:<root_dir>.pdf)--no-tocOmit table of contents--title-pageInclude a title page--title TITLESet title for title page (default: directory name)--author AUTHORSet author for title page (default: OS user)--pandoc-args ARGSExtra Pandoc arguments (whitespace-separated)-c, --config FILEPath to amdfusion.tomlconfig file (default:mdfusion.tomlin 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
Project details
Release history Release notifications | RSS feed
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.2.0.tar.gz
(8.3 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mdfusion-0.2.0.tar.gz.
File metadata
- Download URL: mdfusion-0.2.0.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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a1da874b68d6e329408503d5cd1a2c773d9c751e621c0b7992beb97f0593e503
|
|
| MD5 |
d2f93e618c966210d65ef2a90572dfaf
|
|
| BLAKE2b-256 |
634f6ee024020930764eb479f3c60aa1c265fc309866c6fdef7bb9560376b3b4
|
File details
Details for the file mdfusion-0.2.0-py3-none-any.whl.
File metadata
- Download URL: mdfusion-0.2.0-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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6780b055971686d301a203adfb10d7735b079a5a15b7ca31c4d304e98ac22c30
|
|
| MD5 |
03897751483689e229d2b11a6afb9508
|
|
| BLAKE2b-256 |
d3347b8398b48a14647189a1560b153d8d1288516ef5ded8aa6bdcac4b3f893d
|