https://github.com/jmaupetit/md2pdf
Markdown to PDF with styles
https://github.com/jmaupetit/md2pdf
css markdown pdf pdf-generation
Last synced: 5 months ago
JSON representation
Markdown to PDF with styles
- Host: GitHub
- URL: https://github.com/jmaupetit/md2pdf
- Owner: jmaupetit
- License: mit
- Created: 2013-07-01T19:26:04.000Z (almost 13 years ago)
- Default Branch: main
- Last Pushed: 2026-01-12T18:02:37.000Z (6 months ago)
- Last Synced: 2026-01-12T18:34:24.400Z (6 months ago)
- Topics: css, markdown, pdf, pdf-generation
- Language: Python
- Homepage:
- Size: 432 KB
- Stars: 394
- Watchers: 5
- Forks: 51
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Convert Markdown files to PDF with styles.
## Installation
The easiest way to test `md2pdf` is to use `uv`:
```bash
$ uv tool install md2pdf
```
_Nota bene:_ ensure, Weasyprint is fully functional before using md2pdf. You
will find installation instructions in the project documentation:
[https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation](https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#installation)
## Usage
### As a CLI
```
Usage: md2pdf [OPTIONS] MD PDF
md2pdf command line tool.
Options:
--css PATH
-e, --extras TEXT
--version Show the version and exit.
--help Show this message and exit.
```
For example, try to generate the project documentation with:
```bash
$ md2pdf README.md README.pdf
```
Optionally, you may load an external style:
```bash
$ md2pdf \
--css examples/custom-styles.css \
README.md \
README.pdf
```
And activate [markdown extensions from
PyMdown](https://facelessuser.github.io/pymdown-extensions/):
```bash
$ md2pdf \
--css examples/custom-styles-with-pygments.css \
--extras 'pymdownx.emoji' \
README.md \
README.pdf
```
> Code blocks should be properly rendered when this extension is active.
### As a library
If you have added `md2pdf` as a dependency for your python project, you can use
`md2pdf` in your code, like:
```python
from md2pdf.core import md2pdf
md2pdf(pdf,
md=None,
raw=None,
css=None,
base_url=None,
extras=[],
context={"foo": 1}
)
```
Function arguments:
* `pdf`: output PDF file path
* `raw`: input markdown raw string content (can contain Jinja instructions)
* `md`: input markdown file path (can contain Jinja instructions)
* `css`: input styles path (CSS)
* `base_url`: absolute base path for markdown linked content (as images)
* `extras`: [markdown extra
extensions](https://python-markdown.github.io/extensions/) that should be
activated
* `context`: variables to inject to rendered Jinja template
### With Docker
Install [Docker](https://www.docker.com/)
Pull the image:
```bash
$ docker pull jmaupetit/md2pdf
```
Now run your image:
```bash
$ docker run --rm \
-v $PWD:/app \
-u "$(id -u):$(id -g)" \
jmaupetit/md2pdf --css styles.css INPUT.MD OUTPUT.PDF
```
### Use Jinja templates as input
Your input markdown file or raw content can include
[Jinja](https://jinja.palletsprojects.com/en/stable/) template tags, and
context can be given in a frontmatter header:
```md
---
groceries:
- name: apple
quantity: 4
- name: orange
quantity: 10
- name: banana
quantity: 6
---
# Groceries
| Item | Quantity |
| ---- | -------- |
{% for item in groceries -%}
| {{ item.name }} | {{ item.quantity }} |
{% endfor %}
```
Or directly as a `md2pdf` argument (see library usage).
You can test this example using:
```bash
$ md2pdf \
--css examples/gutenberg-modern.min.css \
examples/my-music.md.j2 \
examples/my-music.pdf
```
## Contributing
### Hacking
Clone this project first:
```bash
$ git clone git@github.com:jmaupetit/md2pdf.git
```
Install md2pdf along with its dependencies (using
[uv](https://docs.astral.sh/uv/)):
```bash
$ cd md2pdf
$ make bootstrap
```
### Running the test suite
To run the test suite:
```bash
$ make test
```
Lint the code via:
```bash
$ make lint
```
### Ease your life
If you are familiar with GNU Make, we also automate daily tasks using this
lovely tool:
```bash
$ make help
```
## License
`md2pdf` is released under the MIT License. See the bundled LICENSE file for
details.