Skip to content

MarkDown Renderer for the terminal

License

Notifications You must be signed in to change notification settings

MichaelMure/mdr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

28 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdr : MarkDown Renderer

Build Status Go Report Card GitHub license Gitter chat

mdr is a standalone Markdown renderer for the terminal.

Note: Markdown being originally designed to render as HTML, rendering in a terminal is occasionally challenging and some adaptation had to be made.

Examples

rendered markdown rendered table rendered code

Installation

You can grab a pre-compiled binary.

Keybindings

Action Key
Quit ctrl+C, Q
Up , K, ctrl+P
Down , J, ctrl+N
Page Up
Page Down , space

Origin

This tool is an offspring of the git-bug project.

Contribute

PRs accepted.

License

MIT