Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 1.91 KB

README.md

File metadata and controls

82 lines (60 loc) · 1.91 KB

mdview

GTK application which does nothing but renders Markdown document onto the screen, using WebKit.

Usage

If you want display contents of a file called filename.md, just type:

$ mdview filename.md

If you want to read Markdown document from standard input, use - instead of filename:

$ cat filename.md | mdview -

Requirements

How to build

Before you can compile the executable, you need to update dependencies included in the repository as Git submodules. You can do this with:

$ git submodule update --init

After this you need to install other requirements, as well as C++ compiler and CMake if you do not have them installed already. On Ubuntu systems this seems to do the trick:

$ sudo apt install build-essential cmake libwebkit2gtk-4.0-dev libgtkmm-3.0-dev

Then you can proceed to compile the actual executable. This can be done with:

$ mkdir build
$ cd build
$ cmake ..
$ make

And you should have mdview binary available in the build directory.

How to install

After the executable has been compiled, you can install it to your system like this:

$ sudo make install

Keyboard shortcuts

Key Action
^F or / Search
^O Open another file
^Q Quit
h Scroll left
j Scroll down
k Scroll up
l Scroll right
n Go to next search result
N Go to previous search result