Application for displaying Markdown documents
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
ext
.editorconfig
.gitignore
.gitmodules
CMakeLists.txt
LICENSE.md
README.md
mdview.cpp

README.md

mdview

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

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

How to use

$ mdview filename.md