Metadata-Version: 2.1
Name: docViewer
Version: 1.0.1
Summary: document tool
Home-page: UNKNOWN
Author: Abraham
Author-email: abraham.liu@hotmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Dist: click
Requires-Dist: docutils
Requires-Dist: p-config (>=1.2.0)
Requires-Dist: requests
Requires-Dist: tornado

#########
docViewer
#########

``docViewer`` is a small tool to help you write document.


Features
########

- render source markup to html
- live preview while editing


Current support following markup language:

  - reStructuredText
  - plantuml


Usage
#####

Command Line
*************

- render doc to html file
  * ``renderDoc``
  * ``python -m docViewer render``
- live preview doc 
  * ``previewDoc``
  * ``python -m docViewer preview``


Vim Plugin
***********

1. Install the plugin

   ``Plug 'zlqm/docViewer', { 'rtp': 'plugins/vim' }``

2. Editing a rst file and run command

   ``:LivePreview``




Demo
*****

Just run this command and you can preview the doc in browser::

  docViewer ) previewDoc demo.rst
  Start preview server [debug: False] bind to localhost:9000
  visit http://localhost:9000/lite-preview?filename=demo.rst to preview


