Code Monkey home page Code Monkey logo

tpt's Introduction

TPT - Terminal Presentation Tool

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.

Watch the video

Watch the video

Requirements

sudo apt install build-essential ruby libmagickwand-dev imagemagick

Or install ruby from a version manager tool, like: RVM or asdf-vm

Enviroment used to test

  • 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

Install

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

Setup file

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
.
.
.

Usage

tpt <path/to/slide.md> or;

tpt <path/to/slide.md> <start slide number>.

Example:

tpt ~/.tpt/example.md
tpt ~/.tpt/example.md 5

Commands

  • Prev slide: b
  • Next slide: n
  • Quit: q
  • Reload: r

tpt's People

Contributors

guilhermefeitosa66 avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.