https://github.com/mpepping/pandoc
Create PDF documents from markdown files using pandoc
https://github.com/mpepping/pandoc
documentation eisvogel eisvogel-template latex markdown pandoc pandoc-markdown pdf
Last synced: about 2 months ago
JSON representation
Create PDF documents from markdown files using pandoc
- Host: GitHub
- URL: https://github.com/mpepping/pandoc
- Owner: mpepping
- License: bsd-3-clause
- Created: 2024-02-05T09:33:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-28T11:37:21.000Z (2 months ago)
- Last Synced: 2026-04-28T13:32:00.689Z (2 months ago)
- Topics: documentation, eisvogel, eisvogel-template, latex, markdown, pandoc, pandoc-markdown, pdf
- Language: TeX
- Homepage:
- Size: 726 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pandoc
Pet project to create PDF documents from markdown files using pandoc. See the `./template` folder for an example. Uses the Latex Eisvogel template.
See and example [PDF document](./template/notes.pdf) here.
## Usage
This projects run as a container image so you need to have Docker or Podman installed. Copy the files from the `./template` folder, update the `MD_NAME` value in the `Makefile` from `notes` to the filename matching your Markdown file:
```make, Makefile
MD_NAME = notes # Update this value to match your markdown file
```
Run `make` (or `make help`) to create a PDF from your Markdown document. The PDF will be created as `$MD_NAME.pdf`.
Alternatively, if you don't have `make` installed, you can run `docker` (or `podman`, `container`) directly:
```bash
docker run -i --rm \
-v ${PWD}:/workdir:z -w /workdir --entrypoint /bin/bash \
ghcr.io/mpepping/pandoc:latest ./run-pandoc.sh $(MD_NAME)
```
## Examples
1. Run `make` to create a PDF file with TOC, titlepage and section numbering.
1. Run `make MD_NAME=myfile` to create a PDF file from `myfile.md`.
1. Run `make markdown2pdf MD_NAME=myfile` to generate a simple PDF file from `myfile.md`.
1. Run `make help` to see the available commands.