1
<div align="center">
2
3
<h1>
4
<picture>
5
<source media="(prefers-color-scheme: dark)" srcset="logo_dark.svg">
6
<source media="(prefers-color-scheme: light)" srcset="logo_light.svg">
7
<img alt="Helix" height="128" src="logo_light.svg">
8
</picture>
9
</h1>
10
11
[](https://github.com/helix-editor/helix/actions)
12
[](https://github.com/helix-editor/helix/releases/latest)
13
[](https://docs.helix-editor.com/)
14
[](https://github.com/helix-editor/helix/graphs/contributors)
15
[](https://matrix.to/#/#helix-community:matrix.org)
16
17
</div>
18
19
20
21
A [Kakoune](https://github.com/mawww/kakoune) / [Neovim](https://github.com/neovim/neovim) inspired editor, written in Rust.
22
23
The editing model is very heavily based on Kakoune; during development I found
24
myself agreeing with most of Kakoune's design decisions.
25
26
For more information, see the [website](https://helix-editor.com) or
27
[documentation](https://docs.helix-editor.com/).
28
29
All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).
30
31
[Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting)
32
33
# Features
34
35
- Vim-like modal editing
36
- Multiple selections
37
- Built-in language server support
38
- Smart, incremental syntax highlighting and code editing via tree-sitter
39
40
Although it's primarily a terminal-based editor, I am interested in exploring
41
a custom renderer (similar to Emacs) using wgpu.
42
43
Note: Only certain languages have indentation definitions at the moment. Check
44
`runtime/queries/<lang>/` for `indents.scm`.
45
46
# Installation
47
48
[Installation documentation](https://docs.helix-editor.com/install.html).
49
50
[](https://repology.org/project/helix-editor/versions)
51
52
# Contributing
53
54
Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).
55
56
# Getting help
57
58
Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).
59
60
Discuss the project on the community [Matrix Space](https://matrix.to/#/#helix-community:matrix.org) (make sure to join `#helix-editor:matrix.org` if you're on a client that doesn't support Matrix Spaces yet).
61
62
# Credits
63
64
Thanks to [@jakenvac](https://github.com/jakenvac) for designing the logo!
65
