b13d44156c
* Show infobox to hint textobjects with `mi` and `ma` * Add note to infobox than any pair of characters will work too The wording could probably be a little more clear, but I wanted to keep it short but still accurate. * Don't allocate a vec for the static help text * Fix bug where `mi<esc>` would swallow next input and persist infobox * Better help text for arbitrary pair matching in textobject selection * Add way to add fake pending key data below status, use with `mi`/`ma` This is a bit hacky as it makes use of global state which will end up managed in multiple places, but has precedent in the way autoinfo works. There should probably be a bigger refactor to handle this kind of state better. * Return early on anything other than `mi` and `ma` for autoinfo * Remove "ascii" from help text with `mi` and `ma` * Update helix-term/src/ui/editor.rs Co-authored-by: Blaž Hrastnik <blaz@mxxn.io> |
3 years ago | |
---|---|---|
.cargo | 3 years ago | |
.github | 3 years ago | |
book | 3 years ago | |
contrib | 3 years ago | |
docs | 3 years ago | |
helix-core | 3 years ago | |
helix-dap | 3 years ago | |
helix-lsp | 3 years ago | |
helix-syntax | 3 years ago | |
helix-term | 3 years ago | |
helix-tui | 3 years ago | |
helix-view | 3 years ago | |
runtime | 3 years ago | |
xtask | 3 years ago | |
.envrc | 3 years ago | |
.gitignore | 3 years ago | |
.gitmodules | 3 years ago | |
CHANGELOG.md | 3 years ago | |
Cargo.lock | 3 years ago | |
Cargo.toml | 3 years ago | |
LICENSE | 4 years ago | |
README.md | 3 years ago | |
TODO.md | 3 years ago | |
base16_theme.toml | 3 years ago | |
flake.lock | 3 years ago | |
flake.nix | 3 years ago | |
languages.toml | 3 years ago | |
rust-toolchain.toml | 3 years ago | |
rustfmt.toml | 3 years ago | |
screenshot.png | 4 years ago | |
shell.nix | 3 years ago | |
theme.toml | 3 years ago |
README.md
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 --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
.
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_RUNTIME
path, it will automatically detect theruntime
directory 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).