Skip to content

A terminal based preview tool for markdown 🍪

License

Notifications You must be signed in to change notification settings

0x00-ketsu/slides

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Slides

A terminal based preview tool for markdown.

image

Features

  • Turning: turn next/previous slide
  • Scroll: scroll up/down slide
  • Search: search word
  • Tagbar: a preview of slides

Install

Go

go install github.com/0x00-ketsu/slides@latest

From source

git clone https://github.com/0x00-ketsu/slides.git
cd slides
make build

Usage

Quickly

Create(or copy an exist) a markdown file contains your slides, here's a simple example:

# Welcome to Slides
A Terminal based preview tool for markdown

---

# h1
## h2
### h3
#### h4
##### h5
###### h6

---

# Markdown components
You can use everything in markdown!
* Like bulleted list
* You know the deal

1. Numbered lists too

---

# Tables

| Tables | Too    |
| ------ | ------ |
| Even   | Tables |

Then, run:

slides example.md 

slides is accepts input from stdin:

curl http://example.com/slides.md | slides

Keymaps

Slide

Go to specific slide:

  • number: 1-9

Go to first slide:

  • g

Go to last slide:

  • G

Go to previous slide:

  • h

Go to next slide:

  • l

Scroll donw/up slide:

  • j: scroll down
  • k: scroll up

Search

  • /: active search
  • n: goto next slide if search word is matched
  • N: goto previous slide if search word is matched

Tagbar

Toggle Tagbar, default is hide

  • t

Help

  • ?

Quit

  • q esc ctrl-c

Inspiration by

License

MIT

About

A terminal based preview tool for markdown 🍪

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published