mdp

Launch a presentation in the terminal from a Markdown file

$ mdp [presentation.md]

$ mdp [[-f|--nofade]] [presentation.md]

$ mdp [[-i|--invert]] [presentation.md]

$ mdp [[-t|--notrans]] [presentation.md]

mdp [OPTIONS] file.md
mdp -h

file.md
    The Markdown file to display or present.

-h, --help
    Display a brief help message and exit.

-v, --version
    Show program's version information and exit.

-i, --image
    Enable image display using detected terminal capabilities (Sixel or iTerm2).

-s, --sixel
    Force Sixel image protocol for image rendering.

-t, --iTerm2
    Force iTerm2 image protocol for image rendering.

-w, --watch
    Watch the input file for changes and automatically reload the presentation.

-n, --no-pager
    Disable slide-by-slide presentation mode; display the entire content continuously.

-c , --config
    Specify an alternative configuration file path.

-k, --keys
    Display a list of available keybindings for navigation and control.

mdp is a lightweight, terminal-based Markdown presentation tool that allows users to display Markdown files directly within a terminal emulator. It renders content with syntax highlighting, proper formatting, and supports a slide-by-slide navigation mode, making it ideal for live presentations or quick document reviews without leaving the command line.

It leverages ncurses for its interactive terminal interface and can display images in compatible terminals (e.g., those supporting Sixel or iTerm2 image protocols). mdp aims to provide a fast and efficient way to consume Markdown content in a command-line environment.

mdp's functionality, especially image display, heavily depends on the capabilities of the terminal emulator being used. Not all terminals support true color, Sixel, or iTerm2 image protocols. Markdown parsing might not cover all obscure or highly specific Markdown extensions. Installation is typically via a package manager or compiling from source, as it's not a standard core Linux utility.

While running mdp, various keyboard shortcuts are available for navigation and control:

• Space / PageDown / Right Arrow / Down Arrow: Next slide/page.
• Backspace / PageUp / Left Arrow / Up Arrow: Previous slide/page.
• q / Ctrl+c: Quit the application.
• Home / g / 1G: Go to the first slide.
• End / G: Go to the last slide.
• f: Toggle fullscreen.
• ?: Show help/keybindings.

mdp is an open-source project primarily developed on GitHub, emerging from the need for a simple, fast, and efficient Markdown presentation tool for the terminal. Its development focuses on portability, broad terminal compatibility, and a clean, interactive user experience, providing an alternative to browser-based or more complex presentation solutions. It continuously evolves with contributions from its community.

pandoc(1), less(1), bat(1), glow(1)