Skip to content
MichaelMurePublic

About

MarkDown Renderer for the terminal

Resources

Stars

438 stars

Watchers

7 watching

Forks

Latest commit

 

History

28 Commits

Folders and files

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

About

MarkDown Renderer for the terminal

Resources

Stars

438 stars

Watchers

7 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages