All Projects → Titor8115 → Mandown

Titor8115 / Mandown

Licence: mit
man-page inspired Markdown viewer

Programming Languages

c
50402 projects - #5 most used programming language

Projects that are alternatives of or similar to Mandown

Nnn
n³ The unorthodox terminal file manager
Stars: ✭ 13,138 (+7494.22%)
Mutual labels:  cli, terminal, command-line, console, ncurses, tui
Goaccess
GoAccess is a real-time web log analyzer and interactive viewer that runs in a terminal in *nix systems or through your browser.
Stars: ✭ 14,096 (+8047.98%)
Mutual labels:  cli, terminal, command-line, tui, ncurses
Jquery.terminal
jQuery Terminal Emulator - JavaScript library for creating web-based terminals with custom commands
Stars: ✭ 2,623 (+1416.18%)
Mutual labels:  cli, terminal, command-line, console, tui
Clrcli
CLRCLI is an event-driven library for building line-art user interfaces in C#/.Net command-line applications.
Stars: ✭ 124 (-28.32%)
Mutual labels:  cli, command-line, console, tui
Word Wrap
Wrap words to a specified length.
Stars: ✭ 107 (-38.15%)
Mutual labels:  cli, terminal, command-line, console
Tty Markdown
Convert a markdown document or text into a terminal friendly output.
Stars: ✭ 275 (+58.96%)
Mutual labels:  cli, terminal, console, markdown
Stig
TUI and CLI for the BitTorrent client Transmission
Stars: ✭ 360 (+108.09%)
Mutual labels:  cli, terminal, console, tui
Pulsemixer
CLI and curses mixer for PulseAudio
Stars: ✭ 441 (+154.91%)
Mutual labels:  cli, terminal, console, tui
Neix
neix - a RSS/Atom feed reader for your terminal.
Stars: ✭ 128 (-26.01%)
Mutual labels:  cli, terminal, tui, ncurses
Rang
A Minimal, Header only Modern c++ library for terminal goodies 💄✨
Stars: ✭ 1,080 (+524.28%)
Mutual labels:  cli, terminal, command-line, console
Crossline
A small, self-contained, zero-config, MIT licensed, cross-platform, readline and libedit replacement.
Stars: ✭ 53 (-69.36%)
Mutual labels:  cli, terminal, command-line, console
Window Size
Reliable way to to get the height and width of the terminal/console in a node.js environment.
Stars: ✭ 79 (-54.34%)
Mutual labels:  cli, terminal, command-line, console
Laravel Zero
A PHP framework for console artisans
Stars: ✭ 2,821 (+1530.64%)
Mutual labels:  cli, terminal, command-line, console
S Tui
Terminal-based CPU stress and monitoring utility
Stars: ✭ 2,825 (+1532.95%)
Mutual labels:  cli, terminal, console, tui
Sad
CLI search and replace | Space Age seD
Stars: ✭ 350 (+102.31%)
Mutual labels:  cli, terminal, command-line, tui
Go Termd
Package termd provides terminal markdown rendering, with code block syntax highlighting support.
Stars: ✭ 223 (+28.9%)
Mutual labels:  cli, terminal, command-line, markdown
Dte
A small, configurable console text editor (moved to https://gitlab.com/craigbarnes/dte)
Stars: ✭ 98 (-43.35%)
Mutual labels:  terminal, console, tui, ncurses
Ascii
👾 ASCII Roulette :: ascii art video chat on the cli
Stars: ✭ 202 (+16.76%)
Mutual labels:  cli, terminal, command-line, console
Wonders
🌈 Declarative JavaScript framework to build command-line applications.
Stars: ✭ 34 (-80.35%)
Mutual labels:  cli, terminal, command-line, console
Tooling
Advancing Node.js as a framework for writing great tools
Stars: ✭ 98 (-43.35%)
Mutual labels:  cli, terminal, command-line, console

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

$ 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
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].