A post-modern modal text editor.
Go to file
nosa e10cf08516
Extend tutor file (#2133)
* Adds tutorial sections for multiple areas including:
- Changing selections to uppercase / lowercase
- yanking and pasting
- macros
- selecting to chars with t and f

PS: I got kind of carried away and put off commiting for a while,
    will commit to commit more often in the future.

* Changed section titles to all uppercase

* Added recap and section about jumplist

* Added sections for searching in file, joining lines and indenting lines.

* Removed some trailing whitespace

* Evened out the space between sections to all be 5 lines

* Add section on opening lines (o) and recap

* Changed the amount of lines between sections

This is so that - on a 24 line terminal -
only one section is visible at a time and
page up/page down goes straight to the next
section keeping the header at the top.

* Punctuation error

Co-authored-by: Omnikar <omkar.subramaniam@icloud.com>

* Punctuation error

Co-authored-by: Omnikar <omkar.subramaniam@icloud.com>

* Spelling error

Co-authored-by: Omnikar <omkar.subramaniam@icloud.com>

* Remove unnecessary word

Co-authored-by: Omnikar <omkar.subramaniam@icloud.com>

* Reword note about searches

Co-authored-by: Omnikar <omkar.subramaniam@icloud.com>

* Change word

Co-authored-by: Omnikar <omkar.subramaniam@icloud.com>

* Update tutor file

* Made some small changes suggested by Omnikar

* Added better demo for macros.

* Small changes

- Add newlines at the end
- Make "MACROS" section fit into 22 lines
- Correct mistake of saying helix copied to clipboard in "COPYING AND PASTING TEXT"

* Reformatted notes in copying/pasting section to fit in screen

* Add a note about n and N and their difference to Vim.

* Combine f and t commands into one section.

* Removed t/T section which was merged into the f/F section.

* Merge sections on manipulating case into one.

* Gave section's numbers

* Convert 'press' to 'type' in some places

* Added examples of how prompt lines should look.

* Reformatted notes in copy/pasting section.

* More rewording to more comfortably fit sections on screen.

* Grammatical error.

* Missing periods.

* Missing capital + small reformat

* Fix mis-numbered section

* Reworded to use these conventions when referring to inputs:
- "Press" for single keypresses
- "Type" for multiple keypresses / modifiers
- "Use" when referencing two inputs as a pair.

* till not 'til

* Say 'press' instead of 'type' when referring to symbols

* 'outdent' not 'unindent'

* Typo and grammar.

* Replace all 'press's with 'type's (apart from places it would make no sense in).

* Improve examples for joining and indenting lines.

* Section alignment.

Co-authored-by: Omnikar <omkar.subramaniam@icloud.com>
2022-04-29 09:52:11 +08:00
.cargo docs: Auto generate command list 2021-12-08 10:23:50 +09:00
.github AppImage (#2089) 2022-04-20 10:43:52 +09:00
book fix typos (#2304) 2022-04-27 14:21:20 -05:00
contrib AppImage (#2089) 2022-04-20 10:43:52 +09:00
docs Fix typo (#2264) 2022-04-25 07:26:02 -05:00
helix-core fix typos (#2304) 2022-04-27 14:21:20 -05:00
helix-dap Use which to resolve lsp/dap binaries 2022-02-24 11:38:40 +09:00
helix-loader Only merge top-level array when merging languages.toml (#2215) 2022-04-23 17:10:34 +09:00
helix-lsp fix typos (#2304) 2022-04-27 14:21:20 -05:00
helix-term Wrap current directory picker with overlay widget (#2308) 2022-04-28 22:17:24 +09:00
helix-tui fix typos (#2304) 2022-04-27 14:21:20 -05:00
helix-view fix typos (#2304) 2022-04-27 14:21:20 -05:00
runtime Extend tutor file (#2133) 2022-04-29 09:52:11 +08:00
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 build(deps): bump anyhow from 1.0.56 to 1.0.57 (#2273) 2022-04-26 11:20:58 +08:00
Cargo.toml migrate grammar fetching/building code into helix-loader crate 2022-03-10 17:31:57 +09:00
CHANGELOG.md fix typos (#2304) 2022-04-27 14:21:20 -05:00
flake.lock flake: use builtins.fetchTree to shallow-clone grammar repos 2022-03-10 17:31:57 +09:00
flake.nix flake: use builtins.fetchTree to shallow-clone grammar repos 2022-03-10 17:31:57 +09:00
grammars.nix Use fromTOML on Nix >= 2.6.0 (#1892) 2022-03-30 11:28:05 -05:00
languages.toml feat(lsp): add toml lsp (#2302) 2022-04-27 13:48:04 -05:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md add table of OS/command for copy/symlink the runtime folder to the config (#2073) 2022-04-20 10:44:11 +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 update screenshot (#1879) 2022-03-30 00:16:57 +09:00
shell.nix Fix nix shell by hardcoding the flakecompat library (#2196) 2022-04-20 09:55:09 -05:00
theme.toml theme ui.virtual capture for existing themes 2022-04-20 11:37:23 +09:00
VERSION set VERSION file to dev (#1883) 2022-03-31 16:31:38 +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

Packages are available for various distributions (see Installation docs).

If you would like 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).

OS command
windows xcopy runtime %AppData%/helix/runtime
linux/macos ln -s $PWD/runtime ~/.config/helix/runtime

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.

In order to use LSP features like auto-complete, you will need to install the appropriate Language Server for a language.

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