A post-modern modal text editor.
Go to file
dependabot[bot] 466e69bbb9 build(deps): bump tokio from 1.11.0 to 1.12.0
Bumps [tokio](https://github.com/tokio-rs/tokio) from 1.11.0 to 1.12.0.
- [Release notes](https://github.com/tokio-rs/tokio/releases)
- [Commits](https://github.com/tokio-rs/tokio/compare/tokio-1.11.0...tokio-1.12.0)

---
updated-dependencies:
- dependency-name: tokio
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-09-28 08:28:52 +08:00
.github fix: Cross compile tests as well 2021-08-14 13:32:29 +09:00
book experiment: space+k for LSP doc, K for keep_selections 2021-09-24 10:30:23 +09:00
contrib Move themes to runtime/themes, add link from contrib/themes 2021-06-20 00:07:13 +09:00
docs Add a "vision" document, to help give people a sense of Helix's direction. (#657) 2021-09-02 00:18:56 +09:00
helix-core Implement 'remove_primary_selection' as Alt-, 2021-09-24 10:30:28 +09:00
helix-lsp build(deps): bump tokio from 1.11.0 to 1.12.0 2021-09-28 08:28:52 +08:00
helix-syntax languages: add svelte submodule reference (#766) 2021-09-19 11:55:15 +09:00
helix-term Add tilde expansion for file opening (#782) 2021-09-24 11:21:04 +09:00
helix-tui Bump crossterm from 0.20.0 to 0.21.0 (#644) 2021-08-24 09:17:57 +09:00
helix-view Add option for automatic insertion of closing-parens/brackets/etc (#779) 2021-09-24 10:28:44 +09:00
runtime add everforest dark theme (#760) 2021-09-17 22:40:24 +09:00
.envrc build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
.gitignore Dynamically load grammar libraries at runtime 2021-07-14 10:00:05 +09:00
.gitmodules languages: add svelte support (#733) 2021-09-17 11:04:55 +09:00
Cargo.lock build(deps): bump tokio from 1.11.0 to 1.12.0 2021-09-28 08:28:52 +08:00
Cargo.toml Inline tui as helix-tui fork. 2021-05-09 17:52:55 +09:00
CHANGELOG.md Update CHANGELOG.md (#606) 2021-08-18 09:39:52 +09:00
flake.lock chore(nix): update flake inputs and submodule 2021-09-12 20:11:04 +08:00
flake.nix flake: remove hack to fix helix version (#762) 2021-09-18 09:59:26 +09:00
languages.toml languages: add svelte support (#733) 2021-09-17 11:04:55 +09:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Fix it's -> its (#676) 2021-08-30 17:58:22 +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 Revert parameter underlining on default theme 2021-09-17 14:43:06 +09:00
TODO.md enable smart case regex search by default (#761) 2021-09-20 13:45:07 +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.

Installation

Note: Only certain languages have indentation definitions at the moment. Check runtime/queries/<lang>/ for indents.toml.

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). This location can be overriden 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

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!
  • To use print debugging to the ~/.cache/helix/helix.log file, you must:
    • Print using log::info!, warn!, or error!. (log::info!("helix!"))
    • Pass the appropriate verbosity level option for the desired log level. (hx -v <file> for info, more vs for higher severity inclusive)
  • 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 Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).