Quick Start Guide

help (3) faq (3)
Dmitry Shachnev

This is a quick guide for starting to work with ReText.

System Requirements

This component is needed if you want to use some extra features:

Debian users can find ReText in their testing repository, and Ubuntu users can install it from ppa:mitya57.

Users of other systems can download ReText from the Downloads page. Users of non-X11 systems should also download the icons pack and extract it into icons sub-directory of ReText installation directory.

Starting up

  • After you open ReText, the main editing area will be shown. You can now type the text in your favourite markup language. You can switch between Markdown and ReStructuredText using "Edit → Default editing mode" menu (if both modules are installed).
  • For preview, click "Preview" button or press Ctrl+E. To enable two-panel mode, activate "Live Preview" from "Edit" menu or press Ctrl+L.
  • To insert a page break, look at this page. To see pages layout, use "File → Print Preview" menu option.
  • To set a font, use "Edit → Change default font" option.
  • Files are opened and saved just like in all other text editors. To export a file to a different format, use "File → Export" menu.

Next steps

Look at our Webpages Generator guide or learn how to tune ReText using the configuration file.

  • Anonymous


    Very usefull and good tool.
    But an installation guide for newbies will be highly appreciated.

    • What operating system do you use? If you use Windows, you can find the guide here (note: ReText is not officially supported on Windows).

      If you use Ubuntu, add ppa:mitya57 to your Software Sources, and then install if from the Software Center.

      Last edit: Dmitry Shachnev 2011-11-26

  • Anonymous

    Just wanted to note that even some X11 systems will need the icon pack. I'm running Crunchbang Statler (Debian-stable paired with Openbox) and had a very bare toolbar when I first launched the program. Installing the icon pack fixed things right up, though!


  • Anonymous

    How do I install this on a mac? Would be great if there was a binary/dmg somewhere

    • I don't use Mac myself, but some people successfully do. Ticket 42 contains some instructions and a (quite outdated) DMG.


  • Anonymous

    I try to install it on my windows 7. But when I started it, It seems could not load locale file. There are some words of tool's tip can not display.

  • Endle

    A little hint for other Fedora users.
    Consider install the following packages:


    Maybe part of them is not necessary


  • Anonymous

    Hey, I cannot install ReText no matter what I do. I have installed all the necessary and optional packages, but somehow when I run "sudo ./retext.py" I get the following error:

    Traceback (most recent call last):
    File "./retext.py", line 22, in <module>
    from ReText import *
    File "/home/pedro/Desktop/ReText-4.0.1/ReText/init.py", line 5, in <module>
    import markups
    ImportError: No module named 'markups'

    What am I doing wrong? Can you help me?

    • How are you trying to install ReText? On Debian/Ubuntu you should just do sudo apt-get install retext and it will install all dependencies automatically. Otherwise, you should do sudo pip3 install Markups or sudo easy_install Markups to get the Markups module.


  • Anonymous

    Thanks man, that solved the problem !! Really appreciate your help, I cannot wait to start using this :D


  • Anonymous

    I am running Linux Mint 13 (maya) and have successfully added your repository and installed ReText, but I can only manage to get version 2.1.6. I have tried to install it from the binaries you provide here but without any result.

    It's looking good though!



  • Anonymous

    It would be greatful if you could make the installation process a little bit easier... :-) I know ReText is a great tool. But the installation is really painful!

    I was trying to install ReText on Oracle Linux 6 update 4. I did a fresh install of the OL6 (selecting "Desktop" flavour at the last step of installation), and then installed the required components from third-party repos. The only exception was for PyMarkups which I could not find from other repos and had to install by using "python setup.py install".

    Then I downloaded the ReText 4.1.1 package and tried to use "python retext.py". I got "SyntaxError: invalid syntax" at line 31 of webpages.py:

    [root@roadwarrior ReText-4.1.1]# python retext.py
    Traceback (most recent call last):
    File "retext.py", line 24, in <module>
    from ReText.window import ReTextWindow
    File "/root/ReText-4.1.1/ReText/window.py", line 11, in <module>
    from ReText.webpages import wpInit, wpUpdateAll
    File "/root/ReText-4.1.1/ReText/webpages.py", line 31
    print('Exception occured: %s' % e, file=sys.stderr)
    SyntaxError: invalid syntax

    I guess it is because my python version (which ships with the OS) is 2.6.6? But trying to install and using Python 3.2 (installed from third-party repo using yum) was not successful either. This time it asked for PyQt4 and PySide which I had already installed from third-party repo using yum.

    [root@roadwarrior ReText-4.1.1]# python3.2 retext.py
    Traceback (most recent call last):
    File "/root/ReText-4.1.1/ReText/init.py", line 16, in <module>
    from PyQt5 import QtCore, QtPrintSupport, QtGui, QtWidgets, QtWebKit, QtWebKitWidgets
    ImportError: No module named PyQt5

    During handling of the above exception, another exception occurred:

    Traceback (most recent call last):
    File "/root/ReText-4.1.1/ReText/init.py", line 19, in <module>
    from PyQt4 import QtCore, QtGui, QtWebKit
    ImportError: No module named PyQt4

    During handling of the above exception, another exception occurred:

    Traceback (most recent call last):
    File "retext.py", line 23, in <module>
    from ReText import QtCore, QtWidgets, QtWebKit, datadirs, globalSettings
    File "/root/ReText-4.1.1/ReText/init.py", line 21, in <module>
    from PySide import QtCore, QtGui, QtWebKit
    ImportError: No module named PySide

    Any ideas or suggestions?

    • This time it asked for PyQt4 and PySide which I had already installed from third-party repo using yum.

      You need a version of PyQt5 or PyQt4 or PySide built against Python 3 (the package name is usually python3-something).

      As you can see, we support three different options in ReText. That's hard, but it makes it available for more users. Unfortunately, you can't write such a Qt binding in pure Python, so that needs a binary packages compiled by your distro maintainers.

  • gocko

    I have Ubuntu 12.04 LTS on my computer. I added ppa:mitya57/ppa to my repository, and executed sudo apt-get install retext.
    After that I succesfully started Retext, but it gives me an older version: 2.1.6
    How can I install newer version (5.0.1, at this moment)?


  • Anonymous

    Ubuntu 14.04 - Install ReText using the Synaptic Package Manager - Type retext in the synaptic search bar and go from there. Perfect install. This is a great tool thanks.



Cancel   Add attachments