A simple tool for displaying presentations from *.md files (Markdown) on the terminal, written in Ruby and with much love ❤️
An alternative to: mdp, patat, vimdeck, present (python), etc.
sudo apt install build-essential ruby libmagickwand-dev imagemagick
Or install ruby from a version manager tool, like: RVM or asdf-vm
-
May work on Ubuntu 20.04 and derivatives
-
Ruby 2.5.1 (may work in previous versions and/or current stable versions)
Machine used to test
OS: Pop!_OS 20.10 x86_64
Kernel: 5.11.0-7614-generic
Shell: zsh 5.8
DE: GNOME 3.38.3
Terminal: tilix
CPU: Intel i7-7700 (8) @ 4.200GHz
GPU: NVIDIA GeForce GTX 1070 8GB
Memory: 16G DDR4
git clone https://github.com/guilhermefeitosa66/tpt.git ~/.tpt/
cd ~/.tpt
bundle install
cp tpt.rb ./tpt
echo "export PATH=$PATH:~/.tpt/" >> ~/.bashrc
# or if you use zshell
echo "export PATH=$PATH:~/.tpt/" >> ~/.zshrc
You'll need a *.md (Markdown) file and add at the beginning of the file:
{
"title": "My Terminal Presentation Tool",
"author": "Guilherme Feitoza"
}
--tpt-config
.
.
.
// the rest of your md file
And add this flag: --new-slide in your *.md file, to split the slides sections
.
.
.
--new-slide
.
.
.
tpt <path/to/slide.md> or;
tpt <path/to/slide.md> <start slide number>.
Example:
tpt ~/.tpt/example.md
tpt ~/.tpt/example.md 5
- Prev slide: b
- Next slide: n
- Quit: q
- Reload: r