Helix Mirror
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
David Else 707457c632
Rewrite and refactor all documentation (#5534)
* Rewrite and refactor all documentation

* Rewrite and refactor the guides

* update runtime directory instructions for windows

* Update the Ubuntu 3rd party repo section with 22.10

* Merge from upstream

* Rewrite and refactor all documentation

* Apply suggestions from code review

Apply the suggestions that can be committed from the GitHub web interface.

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>

* Add Windows themes folder

Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com>

* Apply the rest of the suggestions from the code review

* Revert "Apply the rest of the suggestions from the code review"

This reverts commit 498be1b7a1.

* Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation"

This reverts commit 7c8404248f, reversing
changes made to d932969cfc.

* Apply code review suggestions

* Changes after re-reading all documents

* Missed a full stop

* Code review suggestions and remove macOS and Windows specific sections

* Add OpenBSD to heading

* Add back macOS and Windows sections and further simplify and improve

* Change wording to nightly

* Remove README installation section and turn into a link

* Simplify building from source and follow code review suggestions

* Code review revisions

* Fix copy paste mistake

* Apply the latest code review suggestions

* More small code review items

* Change minor modes for code review

* Fix link and typos

* Add note that you need a c++ compiler to install the tree-sitter grammars

* Add pacman example

* Make sure all headings are lower case

* Revert to the original passage adding a reference to Windows that was missing

* Update book/src/guides/adding_languages.md

Fix grammar typo

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>

* Update book/src/install.md

Fix tree sitter typo

Co-authored-by: Michael Davis <mcarsondavis@gmail.com>

* Remove TOC links to main heading

---------

Co-authored-by: CptPotato <3957610+CptPotato@users.noreply.github.com>
Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com>
2 years ago
.cargo enable rendering in integration tests (#5819) 2 years ago
.github update MSRV to 1.65 2 years ago
book Rewrite and refactor all documentation (#5534) 2 years ago
contrib Add Appstream metadata file (#5643) 2 years ago
docs Expand contributing docs (#5967) 2 years ago
helix-core Doc string fix in selection.rs (#6077) 2 years ago
helix-dap feat(dap): implement Restart request (#5651) 2 years ago
helix-loader build(deps): bump toml from 0.6.0 to 0.7.0 (#5726) 2 years ago
helix-lsp build(deps): bump tokio-stream from 0.1.11 to 0.1.12 (#6071) 2 years ago
helix-term feat(dap): implement Restart request (#5651) 2 years ago
helix-tui Update crossterm to 0.26.1 2 years ago
helix-vcs update MSRV to 1.65 2 years ago
helix-view Fix lacking space panic (#6109) 2 years ago
runtime Update queries for godot4 (#6186) 2 years ago
xtask Fix new clippy lints (#5892) 2 years ago
.envrc Work around a nix-direnv issue 3 years ago
.gitattributes Add .gitattributes (#3318) 2 years ago
.gitignore Remove vale from .gitignore 2 years ago
.ignore Add a .ignore file to make ripgrep more useful (#3315) 2 years ago
CHANGELOG.md Add changelog notes for 22.12 (#4822) 2 years ago
Cargo.lock update MSRV to 1.65 2 years ago
Cargo.toml enable rendering in integration tests (#5819) 2 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Rewrite and refactor all documentation (#5534) 2 years ago
VERSION Add changelog notes for 22.12 (#4822) 2 years ago
base16_theme.toml Set ui.text.inactive for official themes 2 years ago
default.nix build(nix): update flake deps, add default.nix file 2 years ago
flake.lock build(nix): fix devshell 2 years ago
flake.nix build(nix): fix devshell 2 years ago
grammars.nix nix: replace `runCommandNoCC` with `runCommand` (#3992) 2 years ago
languages.toml Update queries for godot4 (#6186) 2 years ago
logo.svg Add the new logo! 2 years ago
logo_dark.svg Add logo with text included (#4973) 2 years ago
logo_light.svg Add logo with text included (#4973) 2 years ago
rust-toolchain.toml update MSRV to 1.65 2 years ago
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 3 years ago
screenshot.png update screenshot (#1879) 3 years ago
shell.nix build(nix): update flake deps, add default.nix file 2 years ago
theme.toml Add `markup.strikethrough` theme keys (#5619) 2 years ago

README.md

Helix

Build status GitHub Release Documentation GitHub contributors Matrix Space

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

Installation

Installation documentation.

Packaging status

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

Credits

Thanks to @JakeHL for designing the logo!