mdeck 0.11.2

Installation

Homebrew (macOS / Linux)

brew install mklab-se/tap/mdeck

Pre-built binaries

Download from GitHub Releases.

Cargo

cargo install mdeck

Build from source

git clone https://github.com/mklab-se/mdeck.git
cd mdeck
cargo install --path crates/mdeck

Usage

mdeck slides.md      # Present a markdown file
mdeck --help         # Show all commands
mdeck --version      # Show version

Commands

mdeck spec                             # Print full format specification
mdeck spec --short                     # Print quick reference card
mdeck export slides.md                 # Export slides as PNG images
mdeck ai                               # Show AI status
mdeck ai test                          # Test AI integration
mdeck ai config                        # Open AI config in editor
mdeck config show                      # Display current settings
mdeck config set defaults.theme dark   # Set a config value
mdeck completion zsh                   # Generate shell completions

The mdeck spec command outputs the complete MDeck markdown format specification, including all supported slide layouts, directives, diagram syntax, and visualization types. This is useful both for humans learning the format and for AI agents that need to understand how to write presentations for MDeck.

Shell Completions

# Static completions
mdeck completion bash > ~/.bash_completion.d/mdeck
mdeck completion zsh > ~/.zfunc/_mdeck

# Dynamic completions (recommended)
source <(COMPLETE=bash mdeck)
source <(COMPLETE=zsh mdeck)

Keyboard Controls

Development

cargo build              # Build
cargo test --workspace   # Run tests
cargo clippy --workspace -- -D warnings  # Lint
cargo fmt --all -- --check               # Format check
cargo run -p mdeck     # Run the app

Documentation

The format specification (crates/mdeck/doc/mdeck-spec.md) is the authoritative reference for the MDeck markdown format. It is embedded in the binary and available via mdeck spec.

Important: The spec must be kept up to date whenever features are added or changed. Any new slide layout, directive, visualization type, or keyboard shortcut must be documented in the spec before release.

License

MIT