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.0.0.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

docViewer-1.0.0-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file docViewer-1.0.0.tar.gz.

File metadata

  • Download URL: docViewer-1.0.0.tar.gz
  • Upload date:
  • Size: 8.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.55.2 CPython/3.8.5

File hashes

Hashes for docViewer-1.0.0.tar.gz
Algorithm Hash digest
SHA256 51372caa2b938bdd7593be391ce99ef0a763b98c490740d6500dc4a01fb67251
MD5 13d319255b591685ac08d250d5b6690d
BLAKE2b-256 96e6ef0d9d3fcedbc0ed9a2ceafd9769d9eba466d867ca82b56faeceac15bab0

See more details on using hashes here.

File details

Details for the file docViewer-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: docViewer-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.55.2 CPython/3.8.5

File hashes

Hashes for docViewer-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7f26d86b1f294ffc27d099d5109ddbd9e7cb923f98e344d29be393df18e1611b
MD5 213cbc9634f8162b542c9184827e818f
BLAKE2b-256 1960348df327fbd3d33d0120ebb606cf79933497906ae3f9588a06fce53deade

See more details on using hashes here.

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