2022-12-02 12:56:36 +01:00
< div align = "center" >
2022-12-03 03:05:15 +01:00
< h1 >
< picture >
< source media = "(prefers-color-scheme: dark)" srcset = "logo_dark.svg" >
< source media = "(prefers-color-scheme: light)" srcset = "logo_light.svg" >
< img alt = "Helix" height = "128" src = "logo_light.svg" >
< / picture >
< / h1 >
2022-12-02 04:05:42 +01:00
2021-05-31 14:09:07 +02:00
[](https://github.com/helix-editor/helix/actions)
2022-12-02 12:56:36 +01:00
[](https://github.com/helix-editor/helix/releases/latest)
[](https://docs.helix-editor.com/)
[](https://github.com/helix-editor/helix/graphs/contributors)
[](https://matrix.to/#/#helix-community:matrix.org)
< / div >
2021-05-11 12:46:58 +02:00
2021-05-12 09:49:01 +02:00
2022-09-17 13:34:48 +02:00
A Kakoune / Neovim inspired editor, written in Rust.
2021-05-11 11:50:09 +02:00
2022-09-17 13:34:48 +02:00
The editing model is very heavily based on Kakoune; during development I found
myself agreeing with most of Kakoune's design decisions.
2021-05-11 11:50:09 +02:00
2021-05-31 10:12:09 +02:00
For more information, see the [website ](https://helix-editor.com ) or
[documentation ](https://docs.helix-editor.com/ ).
2021-05-11 12:46:58 +02:00
2021-08-14 06:28:27 +02:00
All shortcuts/keymaps can be found [in the documentation on the website ](https://docs.helix-editor.com/keymap.html ).
[Troubleshooting ](https://github.com/helix-editor/helix/wiki/Troubleshooting )
2021-06-07 02:32:48 +02:00
2021-05-11 11:50:09 +02:00
# Features
- Vim-like modal editing
- Multiple selections
- Built-in language server support
- Smart, incremental syntax highlighting and code editing via tree-sitter
It's a terminal-based editor first, but I'd like to explore a custom renderer
2022-09-17 13:34:48 +02:00
(similar to Emacs) in wgpu or skulpin.
2020-09-21 11:24:16 +02:00
2021-06-07 02:32:48 +02:00
Note: Only certain languages have indentation definitions at the moment. Check
2022-04-29 19:40:59 +02:00
`runtime/queries/<lang>/` for `indents.scm` .
2021-05-12 09:49:01 +02:00
2021-10-29 07:11:42 +02:00
# Installation
2023-03-06 10:27:17 +01:00
[Installation documentation ](https://docs.helix-editor.com/install.html ).
2022-04-09 08:47:32 +02:00
2021-06-22 18:05:08 +02:00
[](https://repology.org/project/helix/versions)
2021-06-01 20:45:07 +02:00
2021-05-11 11:50:09 +02:00
# Contributing
2021-11-17 14:30:11 +01:00
Contributing guidelines can be found [here ](./docs/CONTRIBUTING.md ).
2021-05-11 11:50:09 +02:00
# Getting help
2021-10-16 03:05:29 +02:00
Your question might already be answered on the [FAQ ](https://github.com/helix-editor/helix/wiki/FAQ ).
2021-06-05 05:01:48 +02:00
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).
2022-12-02 04:05:42 +01:00
# Credits
2023-07-17 07:09:19 +02:00
Thanks to [@jakenvac ](https://github.com/jakenvac ) for designing the logo!
