mirror of
https://github.com/ilyakooo0/helix.git
synced 2024-11-28 21:20:23 +03:00
707457c632
* 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 498be1b7a1aec3ff567b95130148628beeef9b77. * Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation" This reverts commit 7c8404248ffef73b80b9051d5a4359c5bcfa5d1a, reversing changes made to d932969cfc9fadda12a74cc01665919dee7152fb. * 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>
65 lines
2.5 KiB
Markdown
65 lines
2.5 KiB
Markdown
<div align="center">
|
|
|
|
<h1>
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="logo_dark.svg">
|
|
<source media="(prefers-color-scheme: light)" srcset="logo_light.svg">
|
|
<img alt="Helix" height="128" src="logo_light.svg">
|
|
</picture>
|
|
</h1>
|
|
|
|
[](https://github.com/helix-editor/helix/actions)
|
|
[](https://github.com/helix-editor/helix/releases/latest)
|
|
[](https://docs.helix-editor.com/)
|
|
[](https://github.com/helix-editor/helix/graphs/contributors)
|
|
[](https://matrix.to/#/#helix-community:matrix.org)
|
|
|
|
</div>
|
|
|
|
|
|
|
|
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](https://helix-editor.com) or
|
|
[documentation](https://docs.helix-editor.com/).
|
|
|
|
All shortcuts/keymaps can be found [in the documentation on the website](https://docs.helix-editor.com/keymap.html).
|
|
|
|
[Troubleshooting](https://github.com/helix-editor/helix/wiki/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](https://docs.helix-editor.com/install.html).
|
|
|
|
[](https://repology.org/project/helix/versions)
|
|
|
|
# Contributing
|
|
|
|
Contributing guidelines can be found [here](./docs/CONTRIBUTING.md).
|
|
|
|
# Getting help
|
|
|
|
Your question might already be answered on the [FAQ](https://github.com/helix-editor/helix/wiki/FAQ).
|
|
|
|
Discuss the project on the community [Matrix Space](https://matrix.to/#/#helix-community:matrix.org) (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](https://github.com/JakeHL) for designing the logo!
|