Skip to content

Getting Started ​

Get up and running with Tap in minutes.

Install Tap ​

Choose your preferred installation method:

Homebrew (macOS/Linux) ​

bash
brew install MiniCodeMonkey/tap/tap

Tap Desktop (macOS) ​

The native app, with tap built in:

bash
brew install --cask MiniCodeMonkey/tap/tap-desktop

Or download Tap-<version>.dmg from the releases page. The app updates itself through Tap > Check for Updates…

Go Install ​

If you have Go installed:

bash
go install github.com/MiniCodeMonkey/tap@latest

Binary Download ​

Download the latest release for your platform from the GitHub releases page.

Available binaries:

  • tap-darwin-amd64 - macOS Intel
  • tap-darwin-arm64 - macOS Apple Silicon
  • tap-linux-amd64 - Linux x64
  • tap-linux-arm64 - Linux ARM64
  • tap-windows-amd64.exe - Windows x64

After downloading, make the binary executable and move it to your PATH:

bash
chmod +x tap-darwin-arm64
mv tap-darwin-arm64 /usr/local/bin/tap

Create Your First Presentation ​

Use tap new to scaffold a new presentation. It opens an interactive wizard that asks for a title, a theme, and a filename; --output and --theme pre-fill those steps:

bash
tap new --output my-talk.md --theme terminal

With no terminal attached, or with --yes, the wizard is skipped and the file is written straight from the flags:

bash
tap new --yes --title "My Talk" --theme terminal --output my-talk.md

It writes my-talk.md with eight starter slides. The first two look like this:

markdown
---
title: "My Talk"
theme: terminal
author: "Your Name"
date: "2026-09-19"
aspectRatio: "16:9"
transition: fade
---

# My Talk

Your Name

---

## Agenda

- Introduction
- Main Content
- Conclusion

<!-- pause -->

Take your time to go through each section.

Start the Dev Server ​

Launch the development server to preview your slides:

bash
tap dev my-talk.md

This starts a local server at http://localhost:3000 with:

  • Live reload on file changes
  • Presenter mode at /presenter
  • Live code execution support

Use arrow keys or space to navigate. Press t to try a different theme, o for the slide overview, s to open the presenter view, and f for fullscreen. See Keyboard Shortcuts.

Basic Slide Syntax ​

Frontmatter ​

Every presentation starts with YAML frontmatter defining global settings:

yaml
---
title: My Presentation
theme: terminal
author: Your Name
date: 2024-01-15
---

Slide Separators ​

Separate slides with three dashes on their own line:

markdown
# First Slide

Content for the first slide.

---

# Second Slide

Content for the second slide.

---

# Third Slide

And so on...

Slide Directives ​

Add per-slide settings using HTML comment blocks:

markdown
---

<!--
layout: two-column
transition: fade
-->

# This Slide Has Custom Settings

Content here...

Build for Production ​

When you're ready to share your presentation, build it as a static site:

bash
tap build my-talk.md

This generates a self-contained folder in dist/. Every path in it is relative and every font is bundled, so it works from any static host, including a GitHub Pages project sub-path, with no configuration.

Live code execution is the one thing a static build cannot do: code blocks with a driver show their code, unexecuted.

To preview the built version locally:

bash
tap serve dist

Next Steps ​

Now that you have the basics, explore the guides to unlock Tap's full potential: