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!



$ 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.


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.


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.


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


Jonathan Terhorst <>


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.

Source Distribution

rstviewer-0.0.8.tar.gz (18.4 kB view hashes)

Uploaded source

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