https://github.com/tslide/tslide

Terminal SlideDeck, supporting markdown.
https://github.com/tslide/tslide

cli markdown presentation slide-deck slides terminal

Last synced: 17 days ago
JSON representation

Terminal SlideDeck, supporting markdown.

• Host: GitHub
• URL: https://github.com/tslide/tslide
• Owner: tslide
• License: mit
• Created: 2012-08-16T18:24:23.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2017-03-13T03:58:00.000Z (over 7 years ago)
• Last Synced: 2024-09-24T15:49:14.137Z (about 2 months ago)
• Topics: cli, markdown, presentation, slide-deck, slides, terminal
• Language: JavaScript
• Homepage:
• Size: 87.9 KB
• Stars: 211
• Watchers: 10
• Forks: 19
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tslide

Terminal SlideDeck (for backend devs)

---

Controls:

  * Left, Right, or HJKL, Page Up, Page Down: change slide.

  * Ctrl-C or Esc    : exit

You can alternatively use a presenter. `tslide` works with the Logitech R800 and R400 out of the box.

---

# Usage

```

tslide README.markdown

```

each slide is a section of a markdown document,

separated a line with `---` (markdown for horizontal rule `
`)

you will notice that this [README.md](https://raw.githubusercontent.com/tslide/tslide/master/README.md) is a valid tslide markdown presentation.


---

## crude js syntax highlighting

```md

# tslide

## Code

‘‘‘js

function fibonacci (n) {

  return n < 2 ? n : fibonacci(n - 1) + fibonacci(n - 2)

}

‘‘‘

```

---

![Demo Code](demo-code.png)

This feature is on by default. Disable via `--no-highlight`.

---

## images

[iTerm 2](https://www.iterm2.com) users can 

take advantage of [its inline image feature](https://www.iterm2.com/images.html) and use 

images in your slides.

```md

# tslide

## Images

![pizza](pizza.png)

There's nothing a pizza can't fix.

```

---

![Demo Images](demo-images.png)

This feature is on by default. Disable via `--no-images`.

---

## emoji

Most terminals can print unicode emoji, and others can print system bitmap emoji

like macosx.

```md

# tslide

## Emoji

:sparkles:

Magic!

```

---

## Why?

I initially wrote this 2 hours before a talk I had to give.

since then, I have given many presentations with it,

and received a number of contributions that has made tslide actually pretty good,

---

## thanks to

* [@mmaleki](https://github.com/mmaleki)

* [@yoshuawuyts](https://github.com/yoshuawuyts)

* [@rafaelrinaldi](https://github.com/rafaelrinaldi)

* [@noffle](https://github.com/noffle)

* [@loklaan](https://github.com/loklaan)

* [@dkundel](https://github.com/dkundel)

for all the pull requests!

---

## cool links

* [xslide](https://github.com/substack/xslide) a tslide compatible presenter in the browser.

---

## License

MIT