Markup languages like markdown are widely used as program documents and personal blogs. While sometimes we tend to work in a command line environment and need to view these makeup files. And there isn't viewers availble to preview them nicely. Now, we have a option.
muv is a Python based previewer using urwid as a base display and support lots of features including highlight, padding and so on.
- Text highlight.
- Code blocks
- Tables
- Source code highlight
- Images and links extraction
- Custom palette
Only support Python3, install with pip:
pip install muv
Notice: urwid package in pipa is outdated, install through github repo in advance.
- python3
- markdown (pip install markdown)
- urwid, urwid package in pipa is outdated, install through github repo
- py-gfm
- beautifulsoup4
From your local git repo directory:
pip install .
$ muv -h
usage: [-h] [-p palette file location] [-c config file location] [--version]
markdown file to view
preview markdown file
positional arguments:
markdown file to view
the file to preview
optional arguments:
-h, --help show this help message and exit
-p palette file location, --palette palette file location
palettes file show how tags or class being rendered
-c config file location, --config config file location
possible configurations supported
--version look up the version
Markup file previewer by sean
Navigations are like less:
j, e, enter, ctrl e, ctrl n: Forward one line, when preceded by a number N, Forward N line
k, y, ctrl k, ctrl p: Backward one line, when preceded by a number N, Backward N line
d, ctrl d: Forward one half-window
e, ctrl e: Backward one half-window
f, ctrl f, space: Forward one window
b, ctrl b: Backward one window
Currently, you can custom your palette file. Default palette file is in muv/conf/palette.json, and it is a json format file which is self described, you can copy this file and put it in the home directory ~/.muv/ and change it whatever you want.
We plan to support user configurations in the future.