Welcome to ReText!

ReText is a simple but powerful editor for Markdown and reStructuredText markup languages. One can also add support for custom markups using Python modules.

To install ReText, make sure that you have Python (3.6 or later) installed, and run pip3 install ReText. By default it installs system wide, pass --user for installing into the user’s home directory. You can also manually download the tarball from PyPI.

ReText requires the following Python modules to run (pip will install them automatically):

• PyQt6
• Markups (2.0 or later)
• Markdown — for Markdown support
• docutils — for reStructuredText support

We also recommend having these packages installed:

• pyenchant — for spell checking support
• chardet — for encoding detection support
• PyQt6-WebEngine — a more powerful preview engine with JavaScript support

Translation files are already compiled for release tarballs and will be automatically loaded. For development snapshots, compile translations using lrelease ReText/locale/*.ts command (on Debian-based systems, use /usr/lib/qt6/bin/lrelease from qt6-l10n-tools package). Translation files can also be loaded from /usr/share/retext/ directory.

You can translate ReText into your language on Transifex.

ReText is Copyright 2011–2024 Dmitry Shachnev, 2011–2023 Maurice van der Pot, and is licensed under GNU GPL (v2+) license, the current version is available in LICENSE_GPL file.

ReText icon is based on accessories-text-editor icon from the Faenza theme.

You can read more about ReText in the wiki.