blob: ffbabc89732ba643bac5b3e3b83fff7df959fc91 (
plain)
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
|
# mdview - simple markdown viewer
A simple markdown viewer with live update mode for editing. Written in posix
shell and uses [cmark-gfm](https://github.com/github/cmark-gfm/) and
[surf web browser](https://surf.suckless.org/). Includes install and uninstall
scripts for convenience, made public in case someone finds it useful.
## Usage
```
mdview [--light|--dark|--auto] [--live] <file.md>
--light Light theme
--dark Dark theme
--auto Follow system (default)
--live Watch file for changes
```
## Features
* light and dark themes, tries to auto-detect preference by default.
* live mode watches file and updates when saved.
* install script so you can run it like a regular installed executable
* cleans up after itself
## dependencies
* [cmark-gfm](https://github.com/github/cmark-gfm)
* [surf web browser](https://surf.suckless.org)
* inotify-tools (optional but needed for live mode)
## Demo
 
|
