Home

Awesome

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

ActionKey
Quit<kbd>ctrl+C</kbd>, <kbd>Q</kbd>
Up<kbd></kbd>, <kbd>K</kbd>, <kbd>ctrl+P</kbd>
Down<kbd></kbd>, <kbd>J</kbd>, <kbd>ctrl+N</kbd>
Page Up<kbd></kbd>
Page Down<kbd></kbd>, <kbd>space</kbd>

Origin

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

Contribute

PRs accepted.

License

MIT