mdr

command module
v0.2.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 26, 2020 License: MIT Imports: 9 Imported by: 0

README

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

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.