Slides in your terminal.

Slides Presentation


Homebrew Snapcraft AUR

Instructions #### MacOS ``` brew install slides ``` #### Arch ``` yay -S slides ``` #### Nixpkgs (unstable) ``` nix-env -iA nixpkgs.slides ``` #### Any Linux Distro running `snapd` ``` sudo snap install slides ``` #### Go ``` go install ``` From source: ``` git clone cd slides go install ``` You can also download a binary from the [releases]( page.


Create a simple markdown file that contains your slides:

# Welcome to Slides
A terminal based presentation tool


## Everything is markdown
In fact, this entire presentation is a markdown file.


## Everything happens in your terminal
Create slides and present them without ever leaving your terminal.


## Code execution
package main

import "fmt"

func main() {
  fmt.Println("Execute code directly inside the slides")

You can execute code inside your slides by pressing `<C-e>`,
the output of your command will be displayed at the end of the current slide.


## Pre-process slides

You can add a code block with three tildes (`~`) and write a command to run *before* displaying
the slides, the text inside the code block will be passed as `stdin` to the command
and the code block will be replaced with the `stdout` of the command.

~~~graph-easy --as=boxart
[ A ] - to -> [ B ]

The above will be pre-processed to look like:

┌───┐  to   ┌───┐
│ A │ ────> │ B │
└───┘       └───┘

For security reasons, you must pass a file that has execution permissions
for the slides to be pre-processed. You can use `chmod` to add these permissions.

chmod +x

Checkout the example slides.

Then, to present, run:


If given a file name, slides will automatically look for changes in the file and update the presentation live.

slides also accepts input through stdin:

curl | slides

Go to the first slide with the following key sequence:

Go to the next slide with any of the following key sequences:

Go to the previous slide with any of the following key sequences:

Go to a specific slide with the following key sequence:

Go to the last slide with the following key:

To quickly jump to the right slide, you can use the search function.

Press /, enter your search term and press Enter
(The search term is interpreted as a regular expression. The /i flag causes case-insensitivity.).

Press ctrl+n after a search to go to the next search result.

Code Execution

If slides finds a code block on the current slides it can execute the code block and display the result as virtual text on the screen.

Press ctrl+e on a slide with a code block to execute it and display the result.


slides allows you to customize your presentation’s look and feel with metadata at the top of your

This section is entirely optional, slides will use sensible defaults if this section or any field in the section is omitted.

theme: ./path/to/theme.json
author: Gopher
date: January 2, 2006
paging: Slide %d / %d

Date format

Given the date January 02, 2006:

Value Translates to
YYYY 2006
YY 06
MMMM January
MM 01
mm 1
DD 02
dd 2


Credits: This project was heavily inspired by lookatme.


See the development documentation