1
0
Fork 0
mirror of https://github.com/helix-editor/helix synced 2024-05-19 15:36:05 +02:00
A post-modern modal text editor. https://helix-editor.com
Go to file
Blaž Hrastnik c67e31830d Add dependabot config 2021-05-30 17:52:56 +09:00
.github Add dependabot config 2021-05-30 17:52:56 +09:00
book Drop selection_lines completely, change move_line_start binding 2021-05-18 18:28:32 +09:00
docs Update architecture.md 2021-05-30 17:52:46 +09:00
helix-core Update architecture.md 2021-05-30 17:52:46 +09:00
helix-lsp Add :fmt (formats the whole file). 2021-05-12 17:24:55 +09:00
helix-syntax Add the LICENSE file. 2021-05-11 01:44:00 +09:00
helix-term Completion: Format docs tabs & highlight in the doc's native language 2021-05-30 17:13:02 +09:00
helix-tui Display more data in completion popups. 2021-05-22 17:33:42 +09:00
helix-view Format document on save 2021-05-30 00:00:15 +09:00
runtime/queries Adjust rust indents 2021-05-30 17:13:32 +09:00
.envrc Add a nix flake with the development environment. 2021-01-19 15:54:51 +09:00
.gitignore Add a nix flake with the development environment. 2021-01-19 15:54:51 +09:00
.gitmodules Import tree sitter queries. 2021-04-08 23:25:35 +09:00
Cargo.lock Update deps, introduce the new tree-sitter lifetimes 2021-05-28 00:00:51 +09:00
Cargo.toml Inline tui as helix-tui fork. 2021-05-09 17:52:55 +09:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Update the README's matrix link 2021-05-30 17:12:43 +09:00
TODO.md Update deps, introduce the new tree-sitter lifetimes 2021-05-28 00:00:51 +09:00
flake.lock Update flake deps 2021-05-29 23:59:30 +09:00
flake.nix Closer to a full flake build via naersk. 2021-05-03 22:39:53 +09:00
languages.toml Golang uses tabs for indentation. 2021-04-23 18:55:34 +09:00
screenshot.png Add screenshot to README. 2021-05-12 16:52:36 +09:00
shell.nix Update deps, introduce the new tree-sitter lifetimes 2021-05-28 00:00:51 +09:00
theme.toml Update deps, introduce the new tree-sitter lifetimes 2021-05-28 00:00:51 +09:00

Helix

Build status

Screenshot

A kakoune / neovim inspired editor, written in Rust.

The editing model is very heavily based on kakoune; during development I found myself agreeing with most of kakoune's design decisions.

For more information, see the website.

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 (similar to emacs) in wgpu or skulpin.

Installation

Note: Only Rust and Golang have indentation definitions at the moment.

We provide packaging for various distributions, but here's a quick method to build from source.

git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term

This will install the hx binary to $HOME/.cargo/bin.

Now copy the runtime/ directory somewhere. Helix will by default look for the runtime inside the same folder as the executable, but that can be overriden via the HELIX_RUNTIME environment variable.

Contributing

Contributors are very welcome! No contribution is too small and all contributions are valued.

Some suggestions to get started:

  • You can look at the good first issue label on the issue tracker.
  • Help with packaging on various distributions needed!
  • If your preferred language is missing, integrating a tree-sitter grammar for it and defining syntax highlight queries for it is straight forward and doesn't require much knowledge of the internals.

We provide an architecture.md that should give you a good overview of the internals.

Getting help

Discuss the project on the community Matrix channel.