Browse Source

add readme

pull/3/head v0.2.0
Michael Muré 2 years ago
parent
commit
81e28545d9
No known key found for this signature in database GPG Key ID: A4457C029293126F
  1. 32
      Readme.md
  2. BIN
      examples/code.png
  3. BIN
      examples/markdown.png
  4. BIN
      examples/table.png

32
Readme.md

@ -0,0 +1,32 @@
# 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)
## Origin
This tool is an offspring of the [git-bug](https://github.com/MichaelMure/git-bug) project.
## Contribute
PRs accepted.
## License
MIT

BIN
examples/code.png

After

Width: 879  |  Height: 593  |  Size: 38 KiB

BIN
examples/markdown.png

After

Width: 879  |  Height: 1355  |  Size: 224 KiB

BIN
examples/table.png

After

Width: 882  |  Height: 684  |  Size: 61 KiB

Loading…
Cancel
Save