• Stars
    star
    423
  • Rank 99,313 (Top 3 %)
  • Language
    Go
  • License
    MIT License
  • Created almost 5 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

MarkDown Renderer for the terminal

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

More Repositories