Metadata-Version: 1.1
Name: mdview
Version: 0.0.1
Summary: Markdown viewer
Home-page: https://github.com/guyru/mdview
Author: Guy Rutenberg
Author-email: guyrutenberg@gmail.com
License: GPLv3+
Description: ======
        mdview
        ======
        Simple markdown viewer inspired by `restview`_.
        
        .. _`restview`: https://github.com/mgedmin/restview
        
        Features:
        
          * Support for different markdown flavors (such as markdown-extra).
          * Auto-reload in browser when previewed file is modified.
          * Syntax highlighting using `Pygments`_.
        
        .. _`Pygments`: http://pygments.org/
        
        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.
        
        .. _`python-markdown`: http://pythonhosted.org/Markdown/extensions/index.html#officially-supported-extensions
        
        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
        =======
        * Author: `Guy Rutenberg`_
        
        .. _`Guy Rutenberg`: http://www.guyrutenberg.com
        
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Framework :: Flask
