|
|
@ -0,0 +1,32 @@ |
|
|
|
# mdr : MarkDown Renderer |
|
|
|
|
|
|
|
[](https://travis-ci.org/MichaelMure/mdr) |
|
|
|
[](https://goreportcard.com/report/github.com/MichaelMure/mdr) |
|
|
|
[](https://github.com/MichaelMure/mdr/blob/master/LICENSE) |
|
|
|
[](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 |
|
|
|
|
|
|
|
 |
|
|
|
 |
|
|
|
 |
|
|
|
|
|
|
|
## 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 |