Skip to main content

Convert Markdown to Beamer PDF presentations

Project description

mdeck

Beautiful PDF slide decks from Markdown. No LaTeX knowledge required.

Write your talk in plain Markdown, run one command, get a professional-looking presentation — powered by Beamer and the Metropolis theme, which is bundled so you don't have to install anything extra.

mdeck talk.md --open

Get started in 2 minutes

1. Install dependencies

brew install pandoc
brew install --cask mactex   # or any TeX distribution with LuaLaTeX

2. Install mdeck

pipx install mdeck

3. Write your talk

---
title: "My Talk"
author: Jane Doe
date: "June 2025"
theme: metropolis
---

# Motivation

Why this problem matters.

# Approach

- Key idea one
- Key idea two

# Results

Lorem ipsum.

4. Build

mdeck talk.md --open

That's it. No \begin{frame}, no preamble, no .cls files to hunt down.


How it works

Each # Heading in your Markdown becomes a slide. Everything else is standard Markdown: bullet lists, bold, italics, code blocks, images. Under the hood, mdeck calls pandoc with the right flags so you never have to.


Customisation

Options can go in the file's YAML frontmatter, on the command line, or both. CLI flags always win.

Frontmatter

Key Default Values
theme (beamer default) Any Beamer theme; metropolis is bundled
aspectratio 169 43 169 1610 149 54 32
pdf-engine lualatex lualatex xelatex pdflatex
mainfont Any font name (LuaLaTeX/XeLaTeX only)
title / author / date Free text

CLI

mdeck [OPTIONS] FILE

  -o, --output PATH               Output PDF path  (default: FILE.pdf)
  --theme TEXT                    Beamer theme
  --aspectratio [43|169|1610|...]  Slide aspect ratio
  --pdf-engine TEXT               PDF engine
  --open                          Open the PDF after building
  --version                       Show version
  --help                          Show help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdeck-0.1.0.tar.gz (12.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdeck-0.1.0-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file mdeck-0.1.0.tar.gz.

File metadata

  • Download URL: mdeck-0.1.0.tar.gz
  • Upload date:
  • Size: 12.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for mdeck-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2ee3da2081702a5a86eae194128e8040785e87200b85163205aa9289a458d032
MD5 ca13bfd5a23246a7da71807573ce56e4
BLAKE2b-256 a7781c4daad15c25da6b51e46b388634701bd672619e8d7f785b1d0d9ec6b67d

See more details on using hashes here.

File details

Details for the file mdeck-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: mdeck-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.5

File hashes

Hashes for mdeck-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1d24c6e9102e50a3cf97141078e0fa816495eda37139c07073bbc5091911cbd
MD5 8aa6be4477d153fd3e17851084357698
BLAKE2b-256 474a06b783bca9beca93aedd4ac67eb5615ba78b8c44d71eda92870c29aa79d0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page