hellricer / mandown

man-page inspired Markdown viewer

mandown

A man-page inspired Markdown pager written in C.

Considering to change the name in later release.

What is it

Need to lookup things from README? Or from manual page? Or perhaps just want to install something cool... (Looking for work buddies)

Sample

• This is nested list
  • 😊 is rendered
    • So is 🌚 🌕 🌖 🌗 🌘 🌑 🌒 🌓 🌔
      • It is 🔥
• Me right now 💀

This is underline

This is italic

This is bold

This is a key

Can you see this strikethrough or this strikethrough?

This is a code block

Install

Current version is incomplete. However, it should work on Linux and OS X.

The Ncurses UI is still being developed.

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

Usage

$ cd mandown
$ ./mandown README.md

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

Scroll Up: ↑, BACKSPACE

Scroll Down: ↓, ENTER

Exit: q

if it compiles but doesn't run, try updating ncurses library.

$ apt-get install libncursesw5-dev

Mandown currently depends on libncursesw. I haven't tested if it could also run under libncurses.

Todo

• Format

  • markdown
  • troff

• Command-line

  • test version
  • document pathfinder

• Ncurses

  • keyboard control
  • coloring