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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: docViewer-1.1.0.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for docViewer-1.1.0.tar.gz
Algorithm Hash digest
SHA256 a9015e15cb13905f7af6978cc0086206dc5d31dbad69028a539bf4d6054b2677
MD5 e4e0e217fe01aa0af402482b3c815362
BLAKE2b-256 10ccbecb54f90f2661c896b3c4e9db9999587d7c5e960bbddd9eb977ccd34390

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docViewer-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for docViewer-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f01ce47ad9b97dde85ee8f42fe88e75349f3b2ea87da0edaf5946cac8ad4a085
MD5 ca9a6eee81fd7c84dbfbba01918d5e66
BLAKE2b-256 9123ba2322fb12f805938f4a0c2bb25dead76c1628c7888d7b3b08e7b8c95b8b

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