Need help with mandown?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Titor8115
169 Stars 10 Forks MIT License 96 Commits 11 Opened issues

Description

man-page inspired Markdown viewer

Services available

!
?

Need anything else?

Contributors list

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

  • Mouse: other key are in progress
    • enable mouse_1 select href
    • correct mouse wheel for scrolling.

Sample

screenshot

Installation

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

Homebrew

$ brew install mandown

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

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

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

Select & Get href: tab or double click mouse 1 & enter

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

From source

$ brew install ncurses
$ brew install libxml2-dev

Precompiled binary

shell
$ brew install mandown

Debian

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

Todo

  • [x] Line fold/wrap on white space
  • [x] Optimized resizing
  • [ ] Table and contents rendering
  • [x] Makefile makeover

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.