https://github.com/retext-project/retext

ReText: Simple but powerful editor for Markdown and reStructuredText
https://github.com/retext-project/retext

editor markdown markdown-editor markup-language restructuredtext

Last synced: 2 days ago
JSON representation

ReText: Simple but powerful editor for Markdown and reStructuredText

• Host: GitHub
• URL: https://github.com/retext-project/retext
• Owner: retext-project
• License: gpl-2.0
• Created: 2015-09-13T16:43:24.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-10-03T08:13:54.000Z (2 months ago)
• Last Synced: 2024-12-03T09:07:29.659Z (9 days ago)
• Topics: editor, markdown, markdown-editor, markup-language, restructuredtext
• Language: Python
• Homepage:
• Size: 3.12 MB
• Stars: 1,889
• Watchers: 59
• Forks: 198
• Open Issues: 77
• Metadata Files:
  • Readme: README.md
  • Changelog: changelog.md
  • License: LICENSE_GPL

Awesome Lists containing this project

• awesome-python-applications - Repo - project/retext/wiki)) Simple but powerful editor for Markdown and reStructuredText markup languages. `(linux)` (<a id="tag-dev" href="#tag-dev">Dev</a> / <a id="tag-dev.editor" href="#tag-dev.editor">Editor</a>)
• fucking-Awesome-Linux-Software - ![Open-Source Software - project/retext)) - A Simple but powerful editor for Markdown and reStructuredText. (Applications / Office)
• Awesome-Linux-Software - ![Open-Source Software - project/retext) - A Simple but powerful editor for Markdown and reStructuredText. (Applications / Office)
• awesome-python-applications - Repo - project/retext/wiki)) Simple but powerful editor for Markdown and reStructuredText markup languages. `(linux)` (<a id="tag-dev" href="#tag-dev">Dev</a> / <a id="tag-dev.editor" href="#tag-dev.editor">Editor</a>)
• starred-awesome - retext - ReText: Simple but powerful editor for Markdown and reStructuredText (Python)
• awesome-hacking-lists - retext-project/retext - ReText: Simple but powerful editor for Markdown and reStructuredText (Python)
• jimsghstars - retext-project/retext - ReText: Simple but powerful editor for Markdown and reStructuredText (Python)

README

        
Welcome to ReText!

==================

[![GitHub Actions status][GitHub Actions SVG]][GitHub Actions]

ReText is a simple but powerful editor for Markdown and reStructuredText markup

languages. One can also add support for [custom markups] using Python modules.

![ReText on Plasma 5 desktop](data/retext-kde5.png)

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](https://pypi.org/project/PyQt6/)

* [Markups](https://pypi.org/project/Markups/) (2.0 or later)

* [Markdown](https://pypi.org/project/Markdown/) — for Markdown support

* [docutils](https://pypi.org/project/docutils/) — for reStructuredText support

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–2024 [Dmitry Shachnev](https://mitya57.me),

2011–2023 [Maurice van der Pot](mailto:[email protected]), 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].

[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/