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 beautiful 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
.mdfusionINI-style config 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 a.mdfusionINI-style config file
Example
mdfusion --title-page --title "My Book" --author "Jane Doe" docs/
Configuration file
You can create a .mdfusion 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.1.7.tar.gz
(7.2 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.1.7.tar.gz.
File metadata
- Download URL: mdfusion-0.1.7.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5cc451ebe74af901fd8e68abdfabe7e961b88fcf3c64711ece96f109cc30122a
|
|
| MD5 |
6905ab2c1b54b3d78cd1a56c47273c39
|
|
| BLAKE2b-256 |
c76e1b999491134abebd2cf06cac860263d4b61da36d244ca9285aa0a8560a1f
|
File details
Details for the file mdfusion-0.1.7-py3-none-any.whl.
File metadata
- Download URL: mdfusion-0.1.7-py3-none-any.whl
- Upload date:
- Size: 5.4 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 |
4dfc04956aa12559a7e289e498b8d495d73795e113aa9cec633c320d9c892cc1
|
|
| MD5 |
6f242161c1f4ae919ccca01ce83b0d98
|
|
| BLAKE2b-256 |
004da71ffe31b1af24c37c18ff45a6c5e4a272aa5d6e5a8ce5f6365818be25b5
|