yigitsever / mandown

man-page inspired Markdown viewer

mandown - mdn

A man-page inspired Markdown pager written in C.

Name change: executable's name changed to mdn

What is it

Need to lookup things from README? Or from manual page? Or perhaps just want to install something cool...

Update

Control: Page up, Page down

Outfile: for input file in XHTML

Sample

Installation

Current version is still being developed for some HTML tags. However, it should work on most Markdown documents.

The installed binary mdn would be at /usr/local/bin/

$ git clone https://github.com/Titor8115/mandown.git
$ cd mandown
$ make install

To remove the binary, you can run the commands below, or remove manually.

$ cd mandown
$ make uninstall

If you just want to compile and test it.

$ cd mandown
$ make

Feel free to create an issue.

Usage

Check out the new sample

$ mdn sample.md

Mouse wheel scrolling is supported! (if your terminal emulator allows)

Scroll Up: ↑, k

Scroll Down: ↓, j, enter

Page Up: space bar, pg up, fn + ↑

Page Down: back space, pg down, fn + ↓

Exit: q

To read detailed usage, run mdn -h

Library dependency

Mandown requires libncurses(w) and libxml2 as compile-time dependencies.

Make sure you have them installed before compiling.

Homebrew

$ brew install ncurses
$ brew install libxml2-dev

Debian

$ apt-get install libncursesw5-dev
$ apt-get install libxml2-dev

Todo

• Piping capability
• Line fold/wrap on white space
• Optimized resizing
• Table and contents rendering
• Makefile makeover