charlespascoe / vmd Goto Github PK

Terminal Markdown Viewer

License: GNU General Public License v3.0

Makefile 0.76% Python 99.24%

vmd's Introduction

Terminal Markdown Viewer

Render markdown in a terminal! Why? Because although Markdown is still readable as-is, if you use Markdown a lot, it's nice to have something to render it with the proper formatting - with bold text and emphasis, etc.

An example:

Installation

Requires Python 3. Install via pip:

$ sudo pip3 install vmd

Note that some features of the render use Unicode (such as for link indicies), so for now terminals that don't support Unicode (or aren't configured to use Unicode and you don't want to change it, which is fair enough) may experience a few issues. If this is a problem, raise an issue or create a pull request.

Usage

$ vmd file.md

Or via standard in:

$ generate-markdown | vmd --stdin

With less:

$ vmd file.md | less -rc

vmd's People

Contributors

Stargazers

Watchers

Forkers

richarson

vmd's Issues

More speed please

First of all thank you, this is my renderer of choice!

I use it in my TUI file manager but it's a tad slow compared to lowdown so it's used only when I ask for a better preview and I'd rather have a better preview all the time.

I see that you haven't touched this for a while but please do, I'm telling about it to anyone who asks me about a good renderer.

Great Stuff

classy code base, kudos!

Tell me when happy then I link people over to here, from mdv.

Cheers,
Gunther

Images print an error

Instead of printing the placeholder or nothing, it prints a error message.

example.md:

![](http://via.placeholder.com/300)

output:

$ vmd example.md                                                                     
Unhandled tag type 'img' found in document > p

Option to not number lines of blocks

 1 ┃ function validateForm() {
 2 ┃
 3 ┃   let x = document.forms["myForm"]["fname"].value;
 4 ┃

but sometimes I have generated blocks that already include line

Wrong paragraph indentation when a paragraph contains a new line

https://github.com/cpascoe95/vmd/blob/ef72fffb610f0c9fe56dfbc9d3910b4583c2176e/vmd/default_formatters.py#L42

When a paragraph is written on more than one line, the first line has a right indentation, but not the following.

Fail to render netsted links

Ninja-IDE's readme also has a nested link that vmd fails to render properly:

[![Ninja-IDE Videos and Screencasts](http://img.youtube.com/vi/xShpNY5w-64/0.jpg)](https://www.youtube.com/channel/UCPopm5397ozfsS8FOSSOWGQ "Ninja-IDE Videos and Screencasts")

It looks like this:

   1.6 Videos

       ¹
     ¹ https://www.youtube.com/channel/UCPopm5397ozfsS8FOSSOWGQ

If I remove the nesting:

[Ninja-IDE Videos and Screencasts](http://img.youtube.com/vi/xShpNY5w-64/0.jpg)(https://www.youtube.com/channel/UCPopm5397ozfsS8FOSSOWGQ "Ninja-IDE Videos and Screencasts")

Then it looks like this:

   1.6 Videos

       Ninja-IDE Videos and Screencasts¹(https://www.youtube.com/channel/UCPopm5397ozfsS8FOSSOWGQ "Ninja-IDE Videos and Screencasts")
     ¹ http://img.youtube.com/vi/xShpNY5w-64/0.jpg