Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aretext/aretext

Minimalist text editor with vim-compatible key bindings.
https://github.com/aretext/aretext

code-editor minimalist modal-editing syntax-highlighting terminal-based text-editor tui vim

Last synced: 2 months ago
JSON representation

Minimalist text editor with vim-compatible key bindings.

Awesome Lists containing this project

README

        

![Test Status](https://github.com/aretext/aretext/actions/workflows/test.yml/badge.svg)

aretext
=======

Minimalist text editor with vim-compatible key bindings.

[![screencast of aretext](screencast.gif)](https://aretext.org)

- Simple and consistent terminal-based UI for distraction-free coding.
- Efficient editing with over 100 vim commands.
- Intuitive and flexible configuration, per language and project.
- Seamless integration with CLI tools (bash, tmux, git, code formatters, compilers, and anything else you use).

*Aretext key bindings are compatible with vim's normal, insert, and visual modes. See [Command Reference](https://aretext.org/docs/command-reference/) for details.*

Getting Started
---------------

- [Install](https://aretext.org/docs/install/)
- [Quickstart](https://aretext.org/docs/quickstart/)
- [User Documentation](https://aretext.org/docs/)
- [Cheat Sheet](https://aretext.org/docs/cheat-sheet.html)

Project Status: Stable and Actively Maintained
----------------------------------------------

As of the 1.0 release, I've implemented every feature I wanted in a text editor! I will continue actively maintaining the project, prioritizing stability and performance improvements over new functionality.

Contributing
------------

Contributions are welcome! Please read the [Contribution Guidelines](CONTRIBUTING.md) to get started.

Developing
----------

See [DEVELOPING](DEVELOPING.md) for steps to build, test, and debug aretext.

Blog Posts and Talks
--------------------

- [FOSDEM lightning talk (2022)](https://archive.fosdem.org/2022/schedule/event/lt_aretext/), also available [on youtube](https://www.youtube.com/watch?v=NJsWEnM5LcM).
- [fuzzy find algorithm](https://devnonsense.com/posts/fuzzy-find-algorithm/)
- [fuzzing the aretext markdown parser](https://devnonsense.com/posts/aretext-markdown-fuzz-test/)
- [incremental parsing in go](https://devnonsense.com/posts/incremental-parsing-in-go/)
- [what's new in aretext 0.5](https://devnonsense.com/posts/aretext-0.5-release/)
- [aretext 0.6 released!](https://devnonsense.com/posts/aretext-0.6-release/)
- [aretext 0.7 release, thinking about 1.0](https://devnonsense.com/posts/aretext-0.7-release/)
- [aretext 1.0 release](https://devnonsense.com/posts/aretext-1.0-release/)

Copyright and License
---------------------

Copyright (C) the aretext authors

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.