Skip to main content

document tool

Project description

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

Project details


Download files

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

Source Distribution

docViewer-1.1.0.tar.gz (10.3 kB view hashes)

Uploaded Source

Built Distribution

docViewer-1.1.0-py3-none-any.whl (16.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page