Skip to main content

Installation

Requirements​

  • Java 11 or higher — Java 17+ recommended. Check with java -version.
  • No other dependencies required.

Download the JAR​

curl -L https://github.com/TJMSolns/MD-Slides/releases/latest/download/md-slides.jar -o md-slides.jar

Or download directly from the GitHub releases page.

Make it convenient​

The simplest setup is an alias:

# Add to ~/.bashrc or ~/.zshrc
alias mdslides='java -jar /path/to/md-slides.jar'

Or create a wrapper script and put it on your PATH:

#!/bin/bash
java -jar /usr/local/lib/md-slides.jar "$@"

Windows — create mdslides.bat:

@echo off
java -jar C:\path\to\md-slides.jar %*

Verify the installation​

java -jar md-slides.jar --version
java -jar md-slides.jar --help

You should see the version and the command list. Then test with a render:

java -jar md-slides.jar render my-talk --theme light

Upgrading​

Download the new JAR and replace the old one, then render your decks again — fixes to the presentation itself (navigation, speaker view, layout) only reach a deck when it is re-rendered. Check CHANGELOG.md for what changed.

Uninstalling​

Delete the JAR and any wrapper script or alias you created. MD-Slides creates no global state other than ~/.mdslides/config.json if you set a global config.