TermDeck

Terminal presentations, written in Markdown or Python. Built on Textual.

Each file in a deck folder is one slide. Navigate with the arrow keys.

Install

pip install termdeck

Optional extras:

pip install "termdeck[music]"   # interactive music-pad slides

Usage

termdeck                # play the bundled sample deck
termdeck ./my-deck      # play your own deck
python -m termdeck      # same thing

Navigate with ← / → arrow keys; quit with Ctrl+C.

Writing a deck

A deck is a folder of slide files. Files are sorted by name.

Markdown slides

# My title

- a bullet
- another bullet

![diagram](diagram.png)

Image paragraphs (![alt](path)) are rendered as images. Relative paths are resolved from the slide file's directory.

Supported formats: png, jpg, jpeg, gif, webp, bmp.

Python slides

A Python slide is a Textual Screen. It must expose a Slide class:

from textual.app import ComposeResult
from textual.screen import Screen
from textual.widgets import Button

class Slide(Screen):
    def compose(self) -> ComposeResult:
        yield Button("Hello")

The screen's widgets are styled by styles/default.tcss, which you can override in your deck if you want. All Textual functionality is available for rich, interactive slides.

Development

pip install -e ".[dev]"
python test.py
python -m build

License

MIT