Skip to main content

Markdown viewer

Project description


Simple markdown viewer inspired by restview.


  • Support for different markdown flavors (such as markdown-extra).
  • Auto-reload in browser when previewed file is modified.
  • Syntax highlighting using Pygments.


To install mdview, use pip:

$ pip install mdview

Or install directly from Git:

$ pip install git+


usage: mdview [-h] [-x EXTENSIONS] [--version] [--debug] filename

Simple markdown viewer.

positional arguments:

optional arguments:
  -h, --help            show this help message and exit
  -x EXTENSIONS, --extensions EXTENSIONS
                        markdown extensions separated by commas. Default:
  --version             show program's version number and exit
  --debug               run server in debug mode


Where can I find a list of supported markdown extensions?

List of supported flavors is available in python-markdown's documentation. By default the extra and codehilite extensions are turned on.

How can I run mdview without any extension?

$ mdview --extensions "" path/to/

What are those error: [Errno 32] Broken pipe errors I see on stderr?

It happens when you close the browser and mdview still tries to send to it information. You can safely ignore this.


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mdview, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size mdview-0.1.0-py3-none-any.whl (17.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size mdview-0.1.0.tar.gz (17.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page