From e2914e36b269eb292ce56e2cf7baa71d11280acf Mon Sep 17 00:00:00 2001 From: tech kaczynski Date: Thu, 24 Sep 2026 21:50:26 +1000 Subject: initial commit. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..ffbabc8 --- /dev/null +++ b/README.md @@ -0,0 +1,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] + --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 +![Light Theme](light-demo.jpg) ![Dark Theme](dark-demo.jpg) + -- cgit v1.2.3