Skip to main content

An in-browser RST viewer with live updating

Project description

rstviewer is a simple program for editing a reStructuredText (RST) file. In fact, it’s being used to edit this file right now!

Usage

Executing

$ rstviewer file.rst

opens a new browser window containing an HTML representation of of file.rst. The browser window refreshes when file.rst is changed.

Options

By default, rstviewer runs in quiet mode – no logging messages are emitted, so as not to interfere with editing in the console. The option -v, which can be specified multiple times, increases the verbosity level.

Security

Practically nonexistent. The program creates an HTTP server which serves all files located in or beneath the directory containing file.rst. This is to facilitate the loading of images and other assets linked by the RST document. Although the server binds only to the local interface, this is still insecure. In short, do not use this program if you are concerned about security.

Requirements

Python 3.5+ and a browser which supports WebSockets. (The package has been tested only on Chrome and Safari, thus far.)

Author

Jonathan Terhorst <terhorst@gmail.com>

Inspiration

NPM package rst-live-preview, which I could not get running.

Project details


Download files

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

Files for rstviewer, version 0.0.4.1
Filename, size File type Python version Upload date Hashes
Filename, size rstviewer-0.0.4.1-py3-none-any.whl (6.7 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page