readme.md (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
# shlide
> a slide deck presentation tool written in pure bash
## Features
- All slides are plain-text files.
- Navigation using `j` / `k` or `n` / `p`.
- Text color and style formatting.
- Pure bash.
## Usage
Create a directory for your slides. Name each slide starting with
a number and a hyphen, like so:
```shell
$ mkdir deck
$ touch deck/1-first-slide.txt
$ touch deck/2-another.txt
# so on
```
Finally, run:
```shell
$ shlide deck/
```
## Formatting
Slide content can be formatted like so:
```txt
Welcome to ${GRN}shlide${RST}. ${STR}Here${RST} are a few bullet points:
- first point
- second point
* ${ITA}sub point${RST}
* ${BLD}another${RST} sub point
```
**Note**: Make sure to `${RST}` (reset) at the end.
A full list of formatting options are below:
### Colors
|Key|Effect |
|-|-|
| `BLK` | black |
| `RED` | red |
| `GRN` | green |
| `YLW` | yellow |
| `BLU` | blue |
| `PUR` | purple |
| `CYN` | cyan |
| `RST` | reset |
### Styles
|Key|Effect |
|-|-|
| `BLD` | bold |
| `DIM` | dim |
| `ITA` | italics |
| `UND` | underline |
| `FLS` | flashing |
| `REV` | reverse |
| `INV` | invert |
| `STR` | strikethrough |
|