https://github.com/jmaupetit/md2pdf

Markdown to PDF conversion tool
https://github.com/jmaupetit/md2pdf

css markdown pdf-generation

Last synced: 12 days ago
JSON representation

Markdown to PDF conversion tool

• Host: GitHub
• URL: https://github.com/jmaupetit/md2pdf
• Owner: jmaupetit
• License: mit
• Created: 2013-07-01T19:26:04.000Z (over 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T17:19:01.000Z (15 days ago)
• Last Synced: 2024-10-29T18:35:06.107Z (15 days ago)
• Topics: css, markdown, pdf-generation
• Language: Python
• Size: 286 KB
• Stars: 271
• Watchers: 7
• Forks: 42
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![md2pdf logo](https://github.com/jmaupetit/md2pdf/raw/main/assets/md2pdf-logo.png)

Convert Markdown files to PDF with styles.

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/jmaupetit/md2pdf/docker-image.yml?logo=docker&label=Docker%20build)

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/jmaupetit/md2pdf/python-package.yml?logo=python&label=Python%20build)

## Installation

The easiest way to go is to use pip:

```bash

$ pip 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 tests/assets/input.css README.md README.pdf

```

And/or activate [markdown extras](https://github.com/trentm/python-markdown2/wiki/Extras):

```bash

$ md2pdf --css pygments.css -e fenced-code-blocks README.md README.pdf

```

### As a library

You can use `md2pdf` in your python code, like:

```python

from md2pdf.core import md2pdf

md2pdf(pdf,

       md=None,

       raw=None,

       css=None,

       base_url=None,

       extras=[],

)

```

Function arguments:

* `pdf`: output PDF file path

* `raw`: input markdown raw string content

* `md`: input markdown file path

* `css`: input styles path (CSS)

* `base_url`: absolute base path for markdown linked content (as images)

* `extras`: [markdown extras](https://github.com/trentm/python-markdown2/wiki/Extras) that should be activated

### 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

```

## Contributing

### Hacking

Clone this project first:

```bash

$ git clone [email protected]:jmaupetit/md2pdf.git

```

Install md2pdf along with its dependencies (using [Poetry](https://python-poetry.org)):

```bash

$ cd md2pdf

$ poetry install

```

### Running the test suite

To run the test suite with your active python version (virtual environment):

```bash

$ poetry run pytest

```

Lint the code via:

```bash

$ poetry run ruff md2pdf

```

### Release a new version

Upload a new release to PyPI:

```

$ poetry build

$ poetry publish

```

### 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.