README.md

Kataglyphis-mdToPdf

Convert markdown to modern slide show or a4paper book. Combining the very light weight markdown language with all the power of LaTeX.

Table of Contents

• About The Project
• Getting Started
  • Build Docker image
  • Build docs
  • Build presentation
  • Build book
  • Build CV
• Dependencies
• Useful tools
• Contributing
• License
• Contact

About The Project

Formulate everything in markdown. Use LaTeX power via Pandoc. Containerized for reproducibility.

Key Features

Feature	Status
Docker image, make everything reproducible	✔️
LaTeX templates	✔️
Comprehensive python scripts	✔️

Getting Started

Prerequisites

• nerdctl (or docker)
• buildkitd running (systemctl --user status buildkit.service)

git clone --recurse-submodules git@github.com:Kataglyphis/Kataglyphis-mdToPdf.git

Build Docker image

nerdctl build . -t pandoc_all

Build docs

uv run --extra docs sphinx-build -W -b html docs docs/_build/html

The generated HTML lands in docs/_build/html/.

Build presentation

./scripts/build_in_container.sh beamer

Build book

./scripts/build_in_container.sh book

Outputs land in data/out/.

Optional host shortcuts if make is installed:

make beamer
make book
make diss
make cv

Strict warning checks can be enabled for any build:

STRICT_WARNINGS=1 make book
STRICT_WARNINGS=1 ./scripts/build_in_container.sh cv

Build CV

./scripts/build_in_container.sh cv

Dependencies

• beamerthemeawesome (git submodule)
• smile (git submodule)

Useful tools

• pandoc

Contributing

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Contact

Jonas Heinle - @Cataglyphis_ - jonasheinle@googlemail.com

Project Link: https://github.com/Kataglyphis/Kataglyphis-mdToPdf