Skip to main content

Add your description here

Project description

Prezo

A TUI-based presentation tool for the terminal, built with Textual.

Display presentations written in Markdown using conventions similar to those of MARP or Deckset.

Features (v0.3)

  • Markdown presentations - MARP/Deckset format with --- slide separators
  • Live reload - Auto-refresh when file changes (1s polling)
  • Keyboard navigation - Vim-style keys, arrow keys, and more
  • Slide overview - Grid view for quick navigation (o)
  • Search - Find slides by content (/)
  • Table of contents - Navigate by headings (t)
  • Go to slide - Jump to specific slide number (:)
  • Presenter notes - Toggle notes panel (p)
  • Themes - 6 color schemes (T to cycle): dark, light, dracula, solarized-dark, nord, gruvbox
  • Timer/Clock - Elapsed time and countdown (c)
  • Edit slides - Open in $EDITOR (e), saves back to source file
  • Export - PDF, HTML, PNG, SVG formats with customizable themes and sizes
  • Image support - Inline and background images with MARP layout directives (left/right/fit)
  • Native image viewing - Press i for full-quality image display (iTerm2/Kitty protocols)
  • Blackout/Whiteout - Blank screen modes (b/w)
  • Command palette - Quick access to all commands (Ctrl+P)
  • Config file - Customizable settings via ~/.config/prezo/config.toml
  • Recent files - Tracks recently opened presentations
  • Position memory - Remembers last slide position per file

Demo

asciicast

Installation

pip install prezo

Or with uv:

uv tool install prezo

Usage

# View a presentation
prezo presentation.md

# Disable auto-reload
prezo --no-watch presentation.md

# Use custom config
prezo -c myconfig.toml presentation.md

# Set image rendering mode
prezo --image-mode ascii presentation.md   # Options: auto, kitty, sixel, iterm, ascii, none

# Export to PDF
prezo -e pdf presentation.md

# Export with options
prezo -e pdf presentation.md --theme light --size 100x30 --no-chrome

Keyboard Shortcuts

Key Action
/ j / Space Next slide
/ k Previous slide
Home / g First slide
End / G Last slide
: Go to slide number
/ Search slides
o Slide overview
t Table of contents
p Toggle notes panel
c Cycle clock display
T Cycle theme
b Blackout screen
w Whiteout screen
i View image (native quality)
e Edit in $EDITOR
r Reload file
Ctrl+P Command palette
? Help
q Quit

Presentation Format

Prezo supports standard Markdown with MARP/Deckset conventions:

---
title: My Presentation
theme: default
---

# First Slide

Content here...

---

# Second Slide

- Bullet points
- Code blocks
- Tables

???
Presenter notes go here (after ???)

---

# Third Slide

<!-- notes: Alternative notes syntax -->

More content...

Themes

Available themes: dark, light, dracula, solarized-dark, nord, gruvbox

Press T to cycle through themes during presentation.

Export Options

Prezo supports multiple export formats: PDF, HTML, PNG, and SVG.

# PDF export
prezo -e pdf presentation.md                    # Default: 80x24, dark theme
prezo -e pdf presentation.md --theme light      # Light theme (for printing)
prezo -e pdf presentation.md --size 100x30      # Custom dimensions
prezo -e pdf presentation.md --no-chrome        # No window decorations
prezo -e pdf presentation.md -o slides.pdf      # Custom output path

# HTML export (single self-contained file)
prezo -e html presentation.md

# Image export (PNG/SVG)
prezo -e png presentation.md                    # All slides as PNG
prezo -e png presentation.md --slide 3          # Single slide (1-indexed)
prezo -e svg presentation.md --scale 2.0        # SVG with scale factor

PDF/PNG/SVG export requires optional dependencies:

pip install prezo[export]
# or
pip install cairosvg pypdf

Development

# Clone and install
git clone https://github.com/user/prezo.git
cd prezo
uv sync

# Run
uv run prezo presentation.md

# Run tests
uv run pytest

# Lint
uv run ruff check .
uv run ruff format .

License

MIT

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

prezo-0.3.1.tar.gz (43.9 kB view details)

Uploaded Source

Built Distribution

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

prezo-0.3.1-py3-none-any.whl (59.2 kB view details)

Uploaded Python 3

File details

Details for the file prezo-0.3.1.tar.gz.

File metadata

  • Download URL: prezo-0.3.1.tar.gz
  • Upload date:
  • Size: 43.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for prezo-0.3.1.tar.gz
Algorithm Hash digest
SHA256 e9cb07b146333b5f469bbbd3cc62680626690a4b1262f47606ae3afcdc7a736d
MD5 ceca8f7be93490c3043a683cf672843f
BLAKE2b-256 77c8a740d162429293a28fd0f3aba287416a1cf4ca37802c6830f08df30da00e

See more details on using hashes here.

File details

Details for the file prezo-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: prezo-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 59.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for prezo-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 45ec0af22d8f4d2e9976574ea649ca98132056654297001c2e762247045f4187
MD5 de313e971e9901c94784b5be52b33c5a
BLAKE2b-256 cce5e628c7c0060858bf308a0149f6b7200818e6ac8d360e2e1d68a0578da037

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