1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
Metadata-Version: 2.2
Name: ReText
Version: 8.1.0
Summary: Simple editor for Markdown and reStructuredText
Author-email: Dmitry Shachnev <mitya57@gmail.com>
License: GPL-2.0-or-later
Project-URL: Homepage, https://github.com/retext-project/retext
Project-URL: Wiki, https://github.com/retext-project/retext/wiki
Project-URL: Issue Tracker, https://github.com/retext-project/retext/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: X11 Applications :: Qt
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Text Editors
Classifier: Topic :: Text Processing :: Markup
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE_GPL
Requires-Dist: Markups[markdown,restructuredtext]>=4.0
Requires-Dist: Pygments
Requires-Dist: PyQt6
Provides-Extra: spellcheck
Requires-Dist: pyenchant; extra == "spellcheck"
Provides-Extra: encoding-detection
Requires-Dist: chardet; extra == "encoding-detection"
Provides-Extra: webengine
Requires-Dist: PyQt6-WebEngine; extra == "webengine"
Welcome to ReText!
==================
[![GitHub Actions status][GitHub Actions SVG]][GitHub Actions]
ReText is a simple but powerful editor for markup languages. It is based on
[Markups] module which supports Markdown, reStructuredText, Textile and
AsciiDoc. One can also add support for [custom markups] using Python modules.
![ReText on Plasma 5 desktop][Screenshot]
To install ReText, make sure that you have [Python] (3.9 or later) installed,
and run `pip3 install ReText`. To avoid system-wide installation, you can
create a [virtual environment] and install from there. You can also manually
download the tarball from [PyPI] or clone the repository, and then run
`./retext.py`.
ReText requires [PyQt6] and [Markups] (4.0 or later) to run. When you run
`pip3 install ReText`, pip will install them automatically, but you can also
install manually and specify markups that you are going to use using extras
syntax, e.g.:
pip3 install Markups[markdown,restructuredtext,textile]
We also recommend having these packages installed:
* [pyenchant](https://pypi.org/project/pyenchant/) — for spell checking support
* [chardet](https://pypi.org/project/chardet/) — for encoding detection support
* [PyQt6-WebEngine](https://pypi.org/project/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–2025 [Dmitry Shachnev](https://mitya57.me),
2011–2023 [Maurice van der Pot](mailto:griffon26@kfk4ever.com), 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].
[Screenshot]: https://raw.githubusercontent.com/retext-project/retext/master/data/retext-kde6.png
[wiki]: https://github.com/retext-project/retext/wiki
[PyPI]: https://pypi.org/project/ReText/
[Transifex]: https://www.transifex.com/mitya57/ReText/
[GitHub Actions]: https://github.com/retext-project/retext/actions
[GitHub Actions SVG]: https://github.com/retext-project/retext/workflows/tests/badge.svg
[custom markups]: https://pymarkups.readthedocs.io/en/latest/custom_markups.html
[Python]: https://www.python.org/
[PyQt6]: https://pypi.org/project/PyQt6/
[Markups]: https://pypi.org/project/Markups/
[virtual environment]: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/
|
