https://github.com/MichaelMure/mdr

MarkDown Renderer for the terminal
https://github.com/MichaelMure/mdr

Last synced: 27 days ago
JSON representation

MarkDown Renderer for the terminal

• Host: GitHub
• URL: https://github.com/MichaelMure/mdr
• Owner: MichaelMure
• License: mit
• Created: 2019-07-20T12:55:05.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-29T04:02:45.000Z (over 2 years ago)
• Last Synced: 2025-03-22T19:03:06.636Z (about 1 month ago)
• Language: Go
• Size: 1.96 MB
• Stars: 434
• Watchers: 8
• Forks: 19
• Open Issues: 13
• Metadata Files:
  • Readme: Readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-starred - MichaelMure/mdr - MarkDown Renderer for the terminal (Go)
• awesome-list - MichaelMure/mdr - MarkDown Renderer for the terminal (Go)
• go-awesome - mdr - Markdown reading tool under the command line (Finished Items / To Organize)

README

        
# mdr : MarkDown Renderer

[![Build Status](https://travis-ci.org/MichaelMure/mdr.svg?branch=master)](https://travis-ci.org/MichaelMure/mdr)

[![Go Report Card](https://goreportcard.com/badge/github.com/MichaelMure/mdr)](https://goreportcard.com/report/github.com/MichaelMure/mdr)

[![GitHub license](https://img.shields.io/github/license/MichaelMure/mdr.svg)](https://github.com/MichaelMure/mdr/blob/master/LICENSE)

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/the-git-bug/Lobby)

`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](examples/markdown.png)

![rendered table](examples/table.png)

![rendered code](examples/code.png)

## Installation

You can grab a [pre-compiled binary](https://github.com/MichaelMure/mdr/releases/latest).

## 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](https://github.com/MichaelMure/git-bug) project.

## Contribute

PRs accepted.

## License

MIT