Skip to content

sibprogrammer/slides

 
 

Repository files navigation

Slides

Slides in your terminal.

Slides Presentation

Installation

Homebrew

  • MacOS
brew install slides
  • Arch
yay -S slides
  • Go
go install github.com/maaslalani/slides@latest

From source:

git clone https://github.com/maaslalani/slides.git
cd slides
go install

You can also download a binary from the releases page.

Usage

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.

---

## Execute code blocks
Press `ctrl+e` on a slide with a code block to execute it
Slides with display the output at the end of the slide.

~~~ruby
puts "Hello, world!"
~~~

---

Include ASCII graphs with GraphViz + graph-easy.
https://dot-to-ascii.ggerganov.com/

┌──────────┐     ┌────────────┐     ┌────────┐
│ GraphViz │ ──▶ │ graph-easy │ ──▶ │ slides │
└──────────┘     └────────────┘     └────────┘

Checkout the example slides.

Then, to present, run:

slides presentation.md

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 http://example.com/slides.md | slides

Go to the next slide with any of the following keys:

  • space
  • right
  • down
  • enter
  • n
  • k
  • l

Go to the previous slide with any of the following keys:

  • left
  • up
  • p
  • h
  • j

Configuration

Theme

slides allows you to customize your presentation's theme.

If you want to use your own custom theme.json, add the following to the top of your presentation.md:

---
theme: ./path/to/theme.json
---

Check out the provided theme.json to use as a base for your custom theme.

Alternatives

Credits: This project was heavily inspired by lookatme.

Development

See the development documentation

About

Terminal based presentation tool

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 99.5%
  • Makefile 0.5%