My mods of a post-modern modal text editor.
Find a file
ahkrr e2d780f993 fix: 2 panics while setting style + off by 1
The panics would occur because set_style 
would draw outside of the the surface. 
Both occured using `find_prev` or `till_prev`
In my case the first panic! would appear
in a terminal with around 80 columns 
in helix/README.md going to the end of the file
with `geglf(`
the second with `geglfX`
The off by one fix ensures that `find_nth_prev` 
starts at the first character to the left
2021-06-07 09:15:08 +09:00
.github Update build.yml 2021-06-06 18:22:18 +09:00
book Add spc w w for window mode 2021-06-07 09:08:08 +09:00
contrib/themes theme: Enable style modifiers in theme.toml, add Ingrid's theme (#113) 2021-06-06 21:45:59 +09:00
docs Update architecture.md 2021-05-30 17:52:46 +09:00
helix-core fix: 2 panics while setting style + off by 1 2021-06-07 09:15:08 +09:00
helix-lsp Install instructions and version number corrections (#148) 2021-06-07 09:14:06 +09:00
helix-syntax Install instructions and version number corrections (#148) 2021-06-07 09:14:06 +09:00
helix-term fix: 2 panics while setting style + off by 1 2021-06-07 09:15:08 +09:00
helix-tui Install instructions and version number corrections (#148) 2021-06-07 09:14:06 +09:00
helix-view Install instructions and version number corrections (#148) 2021-06-07 09:14:06 +09:00
runtime/queries Restored haskell syntax 2021-06-05 01:17:44 +08: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 Added elixir syntax 2021-06-01 21:59:16 -05:00
Cargo.lock theme: Enable style modifiers in theme.toml, add Ingrid's theme (#113) 2021-06-06 21:45:59 +09:00
Cargo.toml Inline tui as helix-tui fork. 2021-05-09 17:52:55 +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 Restored haskell syntax 2021-06-05 01:17:44 +08:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Install instructions and version number corrections (#148) 2021-06-07 09:14:06 +09:00
screenshot.png Add screenshot to README. 2021-05-12 16:52:36 +09:00
shell.nix Nix: add lldb to shell 2021-06-03 10:31:33 +09:00
theme.toml Change help prompt styling 2021-06-01 12:00:25 +09:00
TODO.md 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 or documentation.

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.

NOTE: You should set this to /runtime in development (if running via cargo).

If you want to embed the runtime/ directory into the Helix binary you can build it with:

cargo install --path helix-term --features "embed_runtime"

Arch Linux

There are two packages available from AUR:

  • helix-bin: contains prebuilt binary from GitHub releases
  • helix-git: builds the master branch of this repository

MacOS

Helix can be installed on MacOS through homebrew via:

brew tap helix-editor/helix
brew install helix

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.

Usage

Keyboard shortcuts / Keymap

All shortcuts/keymaps can be found in the documentation on the website:

Getting help

Discuss the project on the community Matrix Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).