Atom Editor with ReStructured Text (RST)

The Atom editor can give you a live updating preview while editing RST files. RST files are used for documentation of code (and at least one graduate thesis has been written in RST) due to it being more flexible than Markdown yet not as complicated as LaTeX. Bitbucket and Github render RST just as they do Markdown for README.rst files.

With Atom, you need to install a plugin to work with RST live preview editing. You can certainly edit without the plugin, but you need the plugin to get live preview in Atom with rst-preview or rst-preview-pandoc.

Install Atom Editor

wget https://atom.io/download/deb
gdebi deb

Install RST preview plugins for Atom

apt install pandoc

apt install git
  1. Start Atom, and click Packages/Settings > View/Install Packages
  2. search for language-restructuredtext and   rst-preview-pandoc
  3. open an .rst file
  4. see a live updating preview by pressing ctrl shift e  (once)

Web RST viewer

live RST preview on the web

Leave a Comment