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

Uploaded Source

Built Distribution

docViewer-1.0.1-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docViewer-1.0.1.tar.gz
  • Upload date:
  • Size: 8.1 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.1.tar.gz
Algorithm Hash digest
SHA256 f50eecb07bcb1cdd4d06f55fa439ccb6d93ca71db064e7a07fb23d168f833aa8
MD5 aec95268105e2be82ba449b4571b67e2
BLAKE2b-256 79f578ddb9700006f4ba34f281f99d90ea3b75a8edc17c8b03e9b3b5ae79fd15

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docViewer-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.9 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ff774dfc6d7a890b96ff105a697953cbdad6bc66a4eaab77e596a5e6ad8af401
MD5 86da483a9efbcdb4bdb4b85b4961a798
BLAKE2b-256 7ce3aba03db712548749ca9a0870fd3894cbed9e8454ccbc2f6a53e3f181eb6b

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