/mdview

MarkDown viewer

Primary LanguagePython

mdview

A simple MarkDown text viewer that monitors a markdown file on disk for changes and displays updates as the file is saved. The markdown is displayed as an HTML page in a python-gtk based webkit viewer.

Requirements

The following python3 dependencies:

  • watchdog - for cross-platform monitoring of files for change (inotify etc)
  • webkit - for displaying HTML
  • gtk3

These can be installed on Debian/Ubunu:

sudo apt-get install python3-watchdog
sudo apt-get install libwebkitgtk-3.0-0
sudo apt-get install gir1.2-webkit-3.0
sudo apt-get install markdown

or on Mac OS X (macports):

sudo easy_install watchdog
sudo port install py27-gtk
sudo port install py27-webkitgtk

To use GitHub markdown:

A markdown processor is also required. I use this one.

Usage

./mdview markdownfile.md

To do

  • DONE Fix linebreak \n chars in viewer
  • DONE Html check of output
  • Syntax colouring / GitHub style sheets
  • Support links
  • Faster updating (don't use glib idle to avoid thread issue)
  • Swap from gtk to Qt (PySide) for native Mac UI