https://github.com/charlespascoe/vmd

Terminal Markdown Viewer
https://github.com/charlespascoe/vmd

Last synced: about 1 year ago
JSON representation

Terminal Markdown Viewer

• Host: GitHub
• URL: https://github.com/charlespascoe/vmd
• Owner: charlespascoe
• License: gpl-3.0
• Created: 2017-04-12T07:41:56.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2019-08-24T19:29:13.000Z (almost 7 years ago)
• Last Synced: 2025-04-12T22:45:57.432Z (about 1 year ago)
• Language: Python
• Size: 241 KB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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:

![A screenshot displaying an example Markdown document, rendered using vmd](https://github.com/cpascoe95/vmd/blob/master/example.png)

## 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`