Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Markdown viewer

Project description

Simple markdown viewer inspired by restview.

Features:

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

Installation

To install mdview, use pip:

pip install mdview

Usage

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

Simple markdown viewer.

positional arguments:
  filename

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

FAQ

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/file.md

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.

Authors

Project details


Release history Release notifications

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.0.1
Filename, size File type Python version Upload date Hashes
Filename, size mdview-0.0.1.tar.gz (17.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page