bee05dd32a
* Add refresh-config and open-config command * clippy * Use dynamic dispatch for editor config * Refactor Result::Ok to Ok * Remove unused import * cargo fmt * Modify config error handling * cargo xtask docgen * impl display for ConfigLoadError * cargo fmt * Put keymaps behind dyn access, refactor config.load() * Update command names * Update helix-term/src/application.rs Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> * Switch to unbounded_channel * Remove --edit-config command * Update configuration docs * Revert "Put keymaps behind dyn access", too hard This reverts commit 06bad8cf492b9331d0a2d1e9242f3ad4e2c1cf79. * Add refresh for keys * Refactor default_keymaps, fix config default, add test * swap -> store, remove unneeded clone * cargo fmt * Rename default_keymaps to default Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> |
||
|---|---|---|
| .cargo | ||
| .github | ||
| book | ||
| contrib | ||
| docs | ||
| helix-core | ||
| helix-dap | ||
| helix-loader | ||
| helix-lsp | ||
| helix-term | ||
| helix-tui | ||
| helix-view | ||
| runtime | ||
| xtask | ||
| .envrc | ||
| .gitignore | ||
| base16_theme.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| flake.lock | ||
| flake.nix | ||
| grammars.nix | ||
| languages.toml | ||
| LICENSE | ||
| README.md | ||
| rust-toolchain.toml | ||
| rustfmt.toml | ||
| screenshot.png | ||
| shell.nix | ||
| theme.toml | ||
Helix
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.
All shortcuts/keymaps can be found in the documentation on 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.
Note: Only certain languages have indentation definitions at the moment. Check
runtime/queries/<lang>/ for indents.toml.
Installation
We provide packaging for various distributions, but here's a quick method to build from source.
git clone https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term
hx --grammar fetch
hx --grammar build
This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars.
Helix also needs its runtime files so make sure to copy/symlink the runtime/ directory into the
config directory (for example ~/.config/helix/runtime on Linux/macOS, or %AppData%/helix/runtime on Windows).
This location can be overridden via the HELIX_RUNTIME environment variable.
Packages already solve this for you by wrapping the hx binary with a wrapper
that sets the variable to the install dir.
NOTE: running via cargo also doesn't require setting explicit
HELIX_RUNTIMEpath, it will automatically detect theruntimedirectory in the project root.
MacOS
Helix can be installed on MacOS through homebrew via:
brew tap helix-editor/helix
brew install helix
Contributing
Contributing guidelines can be found here.
Getting help
Your question might already be answered on the FAQ.
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).