git.iko.soy/helix
on master help sign in
helix/README.md
64 lines 2.7 kB history raw
1<div align="center">
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>
11[![Build status](https://github.com/helix-editor/helix/actions/workflows/build.yml/badge.svg)](https://github.com/helix-editor/helix/actions)
12[![GitHub Release](https://img.shields.io/github/v/release/helix-editor/helix)](https://github.com/helix-editor/helix/releases/latest)
13[![Documentation](https://shields.io/badge/-documentation-452859)](https://docs.helix-editor.com/)
14[![GitHub contributors](https://img.shields.io/github/contributors/helix-editor/helix)](https://github.com/helix-editor/helix/graphs/contributors)
15[![Matrix Space](https://img.shields.io/matrix/helix-community:matrix.org)](https://matrix.to/#/#helix-community:matrix.org)
17</div>
19![Screenshot](./screenshot.png)
21A [Kakoune](https://github.com/mawww/kakoune) / [Neovim](https://github.com/neovim/neovim) inspired editor, written in Rust.
23The editing model is very heavily based on Kakoune; during development I found
24myself agreeing with most of Kakoune's design decisions.
26For more information, see the [website](https://helix-editor.com) or
27[documentation](https://docs.helix-editor.com/).
29All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).
31[Troubleshooting](https://github.com/helix-editor/helix/wiki/Troubleshooting)
33# Features
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
40It's a terminal-based editor first, but I'd like to explore a custom renderer
41(similar to Emacs) in wgpu or skulpin.
43Note: Only certain languages have indentation definitions at the moment. Check
44`runtime/queries/<lang>/` for `indents.scm`.
46# Installation
48[Installation documentation](https://docs.helix-editor.com/install.html).
50[![Packaging status](https://repology.org/badge/vertical-allrepos/helix.svg)](https://repology.org/project/helix/versions)
52# Contributing
54Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).
56# Getting help
58Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).
60Discuss 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).
62# Credits
64Thanks to [@jakenvac](https://github.com/jakenvac) for designing the logo!