Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
.github/workflows/ | H | 11-Oct-2021 | - | 71 | 68 | |
ReText/ | H | 11-Oct-2021 | - | 5,095 | 3,920 | |
data/ | H | 03-May-2022 | - | 162 | 159 | |
icons/ | H | 03-May-2022 | - | |||
locale/ | H | 11-Oct-2021 | - | 25,243 | 25,174 | |
tests/ | H | 11-Oct-2021 | - | 1,450 | 966 | |
.gitignore | H A D | 11-Oct-2021 | 135 | 12 | 11 | |
LICENSE_GPL | H A D | 11-Oct-2021 | 35 KiB | 675 | 553 | |
MANIFEST.in | H A D | 11-Oct-2021 | 238 | 9 | 8 | |
README.md | H A D | 11-Oct-2021 | 2.4 KiB | 54 | 39 | |
changelog.md | H A D | 11-Oct-2021 | 14.1 KiB | 339 | 291 | |
configuration.md | H A D | 11-Oct-2021 | 7.4 KiB | 114 | 95 | |
retext.py | H A D | 11-Oct-2021 | 94 | 8 | 3 | |
setup.py | H A D | 03-May-2022 | 5.1 KiB | 162 | 134 |
README.md
1Welcome to ReText! 2================== 3 4[![GitHub Actions status][GitHub Actions SVG]][GitHub Actions] 5 6ReText is a simple but powerful editor for Markdown and reStructuredText markup 7languages. One can also add support for [custom markups] using Python modules. 8 9![ReText on Plasma 5 desktop](data/retext-kde5.png) 10 11To install ReText, make sure that you have [Python] (3.6 or later) installed, 12and run `pip3 install ReText`. By default it installs system wide, pass 13`--user` for installing into the user’s home directory. You can also manually 14download the tarball from [PyPI]. 15 16ReText requires the following Python modules to run (`pip` will install them 17automatically): 18 19* [PyQt5](https://riverbankcomputing.com/software/pyqt/intro) (5.11 or later) 20* [Markups](https://pypi.org/project/Markups/) (2.0 or later) 21 22We also recommend having these packages installed: 23 24* [Markdown](https://pypi.org/project/Markdown/) — for Markdown support 25* [docutils](https://pypi.org/project/docutils/) — for reStructuredText support 26* [pyenchant](https://pypi.org/project/pyenchant/) — for spell checking support 27* [PyQtWebEngine](https://pypi.org/project/PyQtWebEngine/) — a more powerful 28 preview engine with JavaScript support 29 30Translation files are already compiled for release tarballs and will be 31automatically loaded. For development snapshots, compile translations using 32`lrelease locale/*.ts` command (on Debian-based systems, `lrelease` is 33available in `qttools5-dev-tools` package). Translation files can also be 34loaded from `/usr/share/retext/` directory. 35 36You can translate ReText into your language on [Transifex]. 37 38ReText is Copyright 2011–2021 [Dmitry Shachnev](https://mitya57.me), 392011–2017 [Maurice van der Pot](mailto:griffon26@kfk4ever.com), and is 40licensed under GNU GPL (v2+) license, the current version is available in 41`LICENSE_GPL` file. 42 43ReText icon is based on `accessories-text-editor` icon from the Faenza theme. 44 45You can read more about ReText in the [wiki]. 46 47[wiki]: https://github.com/retext-project/retext/wiki 48[PyPI]: https://pypi.org/project/ReText/ 49[Transifex]: https://www.transifex.com/mitya57/ReText/ 50[GitHub Actions]: https://github.com/retext-project/retext/actions 51[GitHub Actions SVG]: https://github.com/retext-project/retext/workflows/tests/badge.svg 52[custom markups]: https://pymarkups.readthedocs.io/en/latest/custom_markups.html 53[Python]: https://www.python.org/ 54