https://github.com/seonon/muv
command line markdown file previewer
https://github.com/seonon/muv
command-line-tool markdown-viewer urwid
Last synced: 6 months ago
JSON representation
command line markdown file previewer
- Host: GitHub
- URL: https://github.com/seonon/muv
- Owner: seonon
- License: gpl-3.0
- Archived: true
- Created: 2017-08-31T14:47:56.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-04T02:30:04.000Z (almost 9 years ago)
- Last Synced: 2025-09-10T08:55:35.965Z (10 months ago)
- Topics: command-line-tool, markdown-viewer, urwid
- Language: Python
- Size: 240 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# muv - command line markup documents previewer
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.
* [Example](#examples)
* [Features](#features)
* [Installation](#installation)
* [pip](#pip)
* [Manual](#manual)
* [Requirements](#requirements)
* [Manual Instalation](#manual-installation)
* [Usage](#usage)
* [Customization](#customization)
## Examples
## Features
1. Text highlight.
2. Code blocks
3. Tables
4. Source code highlight
5. Images and links extraction
6. Custom palette
## Installation
### `pip`
Only support Python3, install with `pip`:
```
pip install muv
```
Notice: urwid package in pipa is outdated, install through [github repo](http://github.com/urwid/urwid) in advance.
### Manual
#### Requirements
* python3
* markdown (pip install markdown)
* urwid, urwid package in pipa is outdated, install through [github repo](http://github.com/urwid/urwid)
* py-gfm
* beautifulsoup4
#### Manual Installation
From your local git repo directory:
```
pip install .
```
## Usage
```
$ 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
```
### Navigation
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
```
## Customization
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.