Skip to main content

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

Metadata

Release files for docViewer 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for docViewer 1.1.0
File Size Uploaded
docViewer-1.1.0.tar.gz 10.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for docViewer 1.1.0
File Interpreter ABI Platform
docViewer-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 26.4 kB

Release files / docViewer-1.1.0.tar.gz

Download URL docViewer-1.1.0.tar.gz
Size 10.3 kB
Tags Source
SHA-256 checksum
How to use checksums
a9015e15cb13905f7af6978cc0086206dc5d31dbad69028a539bf4d6054b2677
BLAKE2b-256 checksum
How to use checksums
10ccbecb54f90f2661c896b3c4e9db9999587d7c5e960bbddd9eb977ccd34390
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / docViewer-1.1.0-py3-none-any.whl

Download URL docViewer-1.1.0-py3-none-any.whl
Size 16.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f01ce47ad9b97dde85ee8f42fe88e75349f3b2ea87da0edaf5946cac8ad4a085
BLAKE2b-256 checksum
How to use checksums
9123ba2322fb12f805938f4a0c2bb25dead76c1628c7888d7b3b08e7b8c95b8b
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page