mirror of
https://github.com/maaslalani/slides.git
synced 2026-01-10 06:48:01 -05:00
e21cc0c0b3
Closes #1. This change allows users to add a configuration section to their slides, which allows them to specify a different theme if they would like to change the styles of the default theme. A user can add ``` --- theme: ascii --- ``` To use an ascii theme or use `theme: ./styles.json` to specify their own custom JSON theme using glamour styles. Co-authored-by: Britton Hayes <brittonhayes@users.noreply.github.com>
Slides
Slides in your terminal.
Installation
Using a package manager:
- Go
go install github.com/maaslalani/slides
- MacOS
brew install slides
- Arch
yay -S slides
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.
---
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
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
See the configuration documentation
Alternatives
Credits: This project was heavily inspired by lookatme.
Development
See the development documentation