Helix Mirror
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Blaž Hrastnik e1dc1d2d48 Fix release packaging. 4 years ago
.github/workflows Fix release packaging. 4 years ago
book Update book css styling. 4 years ago
docs Fix release packaging. 4 years ago
helix-core Add the LICENSE file. 4 years ago
helix-lsp Add the LICENSE file. 4 years ago
helix-syntax Add the LICENSE file. 4 years ago
helix-term Add the LICENSE file. 4 years ago
helix-tui Add the LICENSE file. 4 years ago
helix-view Add the LICENSE file. 4 years ago
runtime/queries Fix C highlighting inconsistencies. 4 years ago
.envrc Add a nix flake with the development environment. 4 years ago
.gitignore Add a nix flake with the development environment. 4 years ago
.gitmodules Import tree sitter queries. 4 years ago
Cargo.lock Make the config dir locator work on Windows. 4 years ago
Cargo.toml Inline tui as helix-tui fork. 4 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Fix release packaging. 4 years ago
TODO.md Update todos. 4 years ago
flake.lock Bump deps: rust 1.52. 4 years ago
flake.nix Closer to a full flake build via naersk. 4 years ago
languages.toml Golang uses tabs for indentation. 4 years ago
shell.nix Determine runtime dir based on executable location or env override. 4 years ago
theme.toml Define text color (mostly) in theme.toml. 4 years ago

README.md

Helix

Build status

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

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.