My mods of a post-modern modal text editor.
Find a file
Michael Davis c1f677ff75 rename tree_sitter_library in LanguageConfig to 'grammar'
This is not strictly speaking necessary. tree_sitter_library was used by
just one grammar: llvm-mir-yaml, which uses the yaml grammar. This will
make the language more consistent, though. Each language can explicitly
say that they use Some(grammar), defaulting when None to the grammar that
has a grammar_id matching the language's language_id.
2022-03-10 17:31:57 +09:00
.cargo docs: Auto generate command list 2021-12-08 10:23:50 +09:00
.github build(deps): bump actions/checkout from 2 to 3 (#1767) 2022-03-08 09:12:37 +09:00
book Add --edit-config flag to directly open config.toml (#1771) 2022-03-10 00:04:12 +05:30
contrib Move themes to runtime/themes, add link from contrib/themes 2021-06-20 00:07:13 +09:00
docs migrate helix-syntax crate into helix-core and helix-term 2022-03-10 17:31:57 +09:00
helix-core rename tree_sitter_library in LanguageConfig to 'grammar' 2022-03-10 17:31:57 +09:00
helix-dap Use which to resolve lsp/dap binaries 2022-02-24 11:38:40 +09:00
helix-lsp Implement LSP workspace/configuration and workspace/didChangeConfiguration (#1684) 2022-02-28 17:57:22 +09:00
helix-syntax/languages migrate helix-syntax crate into helix-core and helix-term 2022-03-10 17:31:57 +09:00
helix-term migrate helix-syntax crate into helix-core and helix-term 2022-03-10 17:31:57 +09:00
helix-tui Highlight matching text in file picker suggestions (#1635) 2022-03-01 10:30:02 +09:00
helix-view build(deps): bump once_cell from 1.9.0 to 1.10.0 (#1768) 2022-03-08 08:55:23 +08:00
runtime Add comment textobject for surround selection and navigation (#1605) 2022-03-06 10:54:24 +05:30
xtask Add --health command for troubleshooting (#1669) 2022-03-08 14:25:46 +09:00
.envrc Work around a nix-direnv issue 2022-02-25 18:01:47 +09:00
.gitignore Dynamically load grammar libraries at runtime 2021-07-14 10:00:05 +09:00
base16_theme.toml Add markup support (#1525) 2022-01-23 11:18:50 +09:00
Cargo.lock migrate helix-syntax crate into helix-core and helix-term 2022-03-10 17:31:57 +09:00
Cargo.toml migrate helix-syntax crate into helix-core and helix-term 2022-03-10 17:31:57 +09:00
CHANGELOG.md minor: Fix previous version's header 2022-01-04 19:25:59 +09:00
flake.lock use latest nix-cargo-integration which depends on dream2nix (#1758) 2022-03-08 14:14:00 +09:00
flake.nix use latest nix-cargo-integration which depends on dream2nix (#1758) 2022-03-08 14:14:00 +09:00
languages.toml add tree-sitter sources to languages.toml 2022-03-10 17:31:57 +09:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Readme: fix typo (#1695) 2022-02-22 21:31:19 +09:00
rust-toolchain.toml Switch rust-toolchain.toml over to stable 2021-09-08 16:34:04 +09:00
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 2021-07-23 18:11:22 +09:00
screenshot.png Add screenshot to README. 2021-05-12 16:52:36 +09:00
shell.nix build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
theme.toml capture markdown link text as markup.link.text (#1456) 2022-01-09 00:27:50 +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.

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

Troubleshooting

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 the runtime directory in the project root.

Packaging status

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).