Document not found (404)
+This URL is invalid, sorry. Please use the navigation bar or search to continue.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/configuration.html b/master/configuration.html
new file mode 100644
index 00000000..b55414a4
--- /dev/null
+++ b/master/configuration.html
@@ -0,0 +1,576 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Commands
+Command mode can be activated by pressing :. The built-in commands are:
| Name | Description |
|---|---|
:quit, :q | Close the current view. |
:quit!, :q! | Force close the current view, ignoring unsaved changes. |
:open, :o | Open a file from disk into the current view. |
:buffer-close, :bc, :bclose | Close the current buffer. |
:buffer-close!, :bc!, :bclose! | Close the current buffer forcefully, ignoring unsaved changes. |
:buffer-close-others, :bco, :bcloseother | Close all buffers but the currently focused one. |
:buffer-close-others!, :bco!, :bcloseother! | Force close all buffers but the currently focused one. |
:buffer-close-all, :bca, :bcloseall | Close all buffers without quitting. |
:buffer-close-all!, :bca!, :bcloseall! | Force close all buffers ignoring unsaved changes without quitting. |
:buffer-next, :bn, :bnext | Goto next buffer. |
:buffer-previous, :bp, :bprev | Goto previous buffer. |
:write, :w | Write changes to disk. Accepts an optional path (:write some/path.txt) |
:write!, :w! | Force write changes to disk creating necessary subdirectories. Accepts an optional path (:write! some/path.txt) |
:write-buffer-close, :wbc | Write changes to disk and closes the buffer. Accepts an optional path (:write-buffer-close some/path.txt) |
:write-buffer-close!, :wbc! | Force write changes to disk creating necessary subdirectories and closes the buffer. Accepts an optional path (:write-buffer-close! some/path.txt) |
:new, :n | Create a new scratch buffer. |
:format, :fmt | Format the file using the LSP formatter. |
:indent-style | Set the indentation style for editing. ('t' for tabs or 1-16 for number of spaces.) |
:line-ending | Set the document's default line ending. Options: crlf, lf. |
:earlier, :ear | Jump back to an earlier point in edit history. Accepts a number of steps or a time span. |
:later, :lat | Jump to a later point in edit history. Accepts a number of steps or a time span. |
:write-quit, :wq, :x | Write changes to disk and close the current view. Accepts an optional path (:wq some/path.txt) |
:write-quit!, :wq!, :x! | Write changes to disk and close the current view forcefully. Accepts an optional path (:wq! some/path.txt) |
:write-all, :wa | Write changes from all buffers to disk. |
:write-all!, :wa! | Forcefully write changes from all buffers to disk creating necessary subdirectories. |
:write-quit-all, :wqa, :xa | Write changes from all buffers to disk and close all views. |
:write-quit-all!, :wqa!, :xa! | Write changes from all buffers to disk and close all views forcefully (ignoring unsaved changes). |
:quit-all, :qa | Close all views. |
:quit-all!, :qa! | Force close all views ignoring unsaved changes. |
:cquit, :cq | Quit with exit code (default 1). Accepts an optional integer exit code (:cq 2). |
:cquit!, :cq! | Force quit with exit code (default 1) ignoring unsaved changes. Accepts an optional integer exit code (:cq! 2). |
:theme | Change the editor theme (show current theme if no name specified). |
:yank-join | Yank joined selections. A separator can be provided as first argument. Default value is newline. |
:clipboard-yank | Yank main selection into system clipboard. |
:clipboard-yank-join | Yank joined selections into system clipboard. A separator can be provided as first argument. Default value is newline. |
:primary-clipboard-yank | Yank main selection into system primary clipboard. |
:primary-clipboard-yank-join | Yank joined selections into system primary clipboard. A separator can be provided as first argument. Default value is newline. |
:clipboard-paste-after | Paste system clipboard after selections. |
:clipboard-paste-before | Paste system clipboard before selections. |
:clipboard-paste-replace | Replace selections with content of system clipboard. |
:primary-clipboard-paste-after | Paste primary clipboard after selections. |
:primary-clipboard-paste-before | Paste primary clipboard before selections. |
:primary-clipboard-paste-replace | Replace selections with content of system primary clipboard. |
:show-clipboard-provider | Show clipboard provider name in status bar. |
:change-current-directory, :cd | Change the current working directory. |
:show-directory, :pwd | Show the current working directory. |
:encoding | Set encoding. Based on https://encoding.spec.whatwg.org. |
:character-info, :char | Get info about the character under the primary cursor. |
:reload, :rl | Discard changes and reload from the source file. |
:reload-all, :rla | Discard changes and reload all documents from the source files. |
:update, :u | Write changes only if the file has been modified. |
:lsp-workspace-command | Open workspace command picker |
:lsp-restart | Restarts the language servers used by the current doc |
:lsp-stop | Stops the language servers that are used by the current doc |
:tree-sitter-scopes | Display tree sitter scopes, primarily for theming and development. |
:tree-sitter-highlight-name | Display name of tree-sitter highlight scope under the cursor. |
:debug-start, :dbg | Start a debug session from a given template with given parameters. |
:debug-remote, :dbg-tcp | Connect to a debug adapter by TCP address and start a debugging session from a given template with given parameters. |
:debug-eval | Evaluate expression in current debug context. |
:vsplit, :vs | Open the file in a vertical split. |
:vsplit-new, :vnew | Open a scratch buffer in a vertical split. |
:hsplit, :hs, :sp | Open the file in a horizontal split. |
:hsplit-new, :hnew | Open a scratch buffer in a horizontal split. |
:tutor | Open the tutorial. |
:goto, :g | Goto line number. |
:set-language, :lang | Set the language of current buffer (show current language if no value specified). |
:set-option, :set | Set a config option at runtime. For example to disable smart case search, use :set search.smart-case false. |
:toggle-option, :toggle | Toggle a boolean config option at runtime. For example to toggle smart case search, use :toggle search.smart-case. |
:get-option, :get | Get the current value of a config option. |
:sort | Sort ranges in selection. |
:rsort | Sort ranges in selection in reverse order. |
:reflow | Hard-wrap the current selection of lines to a given width. |
:tree-sitter-subtree, :ts-subtree | Display tree sitter subtree under cursor, primarily for debugging queries. |
:config-reload | Refresh user config. |
:config-open | Open the user config.toml file. |
:config-open-workspace | Open the workspace config.toml file. |
:log-open | Open the helix log file. |
:insert-output | Run shell command, inserting output before each selection. |
:append-output | Run shell command, appending output after each selection. |
:pipe | Pipe each selection to the shell command. |
:pipe-to | Pipe each selection to the shell command, ignoring output. |
:run-shell-command, :sh | Run a shell command |
:reset-diff-change, :diffget, :diffg | Reset the diff change at the cursor position. |
:clear-register | Clear given register. If no argument is provided, clear all registers. |
:redraw | Clear and re-render the whole UI |
:move | Move the current buffer and its corresponding file to a different path |
:yank-diagnostic | Yank diagnostic(s) under primary cursor to register, or clipboard by default |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/css/chrome.css b/master/css/chrome.css
new file mode 100644
index 00000000..8b78255d
--- /dev/null
+++ b/master/css/chrome.css
@@ -0,0 +1,606 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+@import 'variables.css';
+
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+
+/*
+ body-container is necessary because mobile browsers don't seem to like
+ overflow-x on the body tag when there is a tag.
+*/
+#body-container {
+ /*
+ This is used when the sidebar pushes the body content off the side of
+ the screen on small screens. Without it, dragging on mobile Safari
+ will want to reposition the viewport in a weird way.
+ */
+ overflow-x: clip;
+}
+
+/* Menu Bar */
+
+#menu-bar,
+#menu-bar-hover-placeholder {
+ z-index: 101;
+ margin: auto calc(0px - var(--page-padding));
+}
+#menu-bar {
+ position: relative;
+ display: flex;
+ flex-wrap: wrap;
+ background-color: var(--bg);
+ border-block-end-color: var(--bg);
+ border-block-end-width: 1px;
+ border-block-end-style: solid;
+}
+#menu-bar.sticky,
+.js #menu-bar-hover-placeholder:hover + #menu-bar,
+.js #menu-bar:hover,
+.js.sidebar-visible #menu-bar {
+ position: -webkit-sticky;
+ position: sticky;
+ top: 0 !important;
+}
+#menu-bar-hover-placeholder {
+ position: sticky;
+ position: -webkit-sticky;
+ top: 0;
+ height: var(--menu-bar-height);
+}
+#menu-bar.bordered {
+ border-block-end-color: var(--table-border-color);
+}
+#menu-bar i, #menu-bar .icon-button {
+ position: relative;
+ padding: 0 8px;
+ z-index: 10;
+ line-height: var(--menu-bar-height);
+ cursor: pointer;
+ transition: color 0.5s;
+}
+@media only screen and (max-width: 420px) {
+ #menu-bar i, #menu-bar .icon-button {
+ padding: 0 5px;
+ }
+}
+
+.icon-button {
+ border: none;
+ background: none;
+ padding: 0;
+ color: inherit;
+}
+.icon-button i {
+ margin: 0;
+}
+
+.right-buttons {
+ margin: 0 15px;
+}
+.right-buttons a {
+ text-decoration: none;
+}
+
+.left-buttons {
+ display: flex;
+ margin: 0 5px;
+}
+.no-js .left-buttons button {
+ display: none;
+}
+
+.menu-title {
+ display: inline-block;
+ font-weight: 200;
+ font-size: 2.4rem;
+ line-height: var(--menu-bar-height);
+ text-align: center;
+ margin: 0;
+ flex: 1;
+ white-space: nowrap;
+ overflow: hidden;
+ text-overflow: ellipsis;
+}
+.js .menu-title {
+ cursor: pointer;
+}
+
+.menu-bar,
+.menu-bar:visited,
+.nav-chapters,
+.nav-chapters:visited,
+.mobile-nav-chapters,
+.mobile-nav-chapters:visited,
+.menu-bar .icon-button,
+.menu-bar a i {
+ color: var(--icons);
+}
+
+.menu-bar i:hover,
+.menu-bar .icon-button:hover,
+.nav-chapters:hover,
+.mobile-nav-chapters i:hover {
+ color: var(--icons-hover);
+}
+
+/* Nav Icons */
+
+.nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+
+ position: fixed;
+ top: 0;
+ bottom: 0;
+ margin: 0;
+ max-width: 150px;
+ min-width: 90px;
+
+ display: flex;
+ justify-content: center;
+ align-content: center;
+ flex-direction: column;
+
+ transition: color 0.5s, background-color 0.5s;
+}
+
+.nav-chapters:hover {
+ text-decoration: none;
+ background-color: var(--theme-hover);
+ transition: background-color 0.15s, color 0.15s;
+}
+
+.nav-wrapper {
+ margin-block-start: 50px;
+ display: none;
+}
+
+.mobile-nav-chapters {
+ font-size: 2.5em;
+ text-align: center;
+ text-decoration: none;
+ width: 90px;
+ border-radius: 5px;
+ background-color: var(--sidebar-bg);
+}
+
+/* Only Firefox supports flow-relative values */
+.previous { float: left; }
+[dir=rtl] .previous { float: right; }
+
+/* Only Firefox supports flow-relative values */
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+[dir=rtl] .next {
+ float: left;
+ right: unset;
+ left: var(--page-padding);
+}
+
+/* Use the correct buttons for RTL layouts*/
+[dir=rtl] .previous i.fa-angle-left:before {content:"\f105";}
+[dir=rtl] .next i.fa-angle-right:before { content:"\f104"; }
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+/* sidebar-visible */
+@media only screen and (max-width: 1380px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wide-wrapper { display: none; }
+ #sidebar-toggle-anchor:checked ~ .page-wrapper .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a) > .hljs {
+ color: var(--inline-code-color);
+ overflow-x: initial;
+}
+
+a:hover > .hljs {
+ text-decoration: underline;
+}
+
+pre {
+ position: relative;
+}
+pre > .buttons {
+ position: absolute;
+ z-index: 100;
+ right: 0px;
+ top: 2px;
+ margin: 0px;
+ padding: 2px 0px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+ visibility: hidden;
+ opacity: 0;
+ transition: visibility 0.1s linear, opacity 0.1s linear;
+}
+pre:hover > .buttons {
+ visibility: visible;
+ opacity: 1
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+ border-color: var(--icons-hover);
+ background-color: var(--theme-hover);
+}
+pre > .buttons i {
+ margin-inline-start: 8px;
+}
+pre > .buttons button {
+ cursor: inherit;
+ margin: 0px 5px;
+ padding: 3px 5px;
+ font-size: 14px;
+
+ border-style: solid;
+ border-width: 1px;
+ border-radius: 4px;
+ border-color: var(--icons);
+ background-color: var(--theme-popup-bg);
+ transition: 100ms;
+ transition-property: color,border-color,background-color;
+ color: var(--icons);
+}
+@media (pointer: coarse) {
+ pre > .buttons button {
+ /* On mobile, make it easier to tap buttons. */
+ padding: 0.3rem 1rem;
+ }
+
+ .sidebar-resize-indicator {
+ /* Hide resize indicator on devices with limited accuracy */
+ display: none;
+ }
+}
+pre > code {
+ display: block;
+ padding: 1rem;
+}
+
+/* FIXME: ACE editors overlap their buttons because ACE does absolute
+ positioning within the code block which breaks padding. The only solution I
+ can think of is to move the padding to the outer pre tag (or insert a div
+ wrapper), but that would require fixing a whole bunch of CSS rules.
+*/
+.hljs.ace_editor {
+ padding: 0rem 0rem;
+}
+
+pre > .result {
+ margin-block-start: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding-block-start: 0;
+ padding-block-end: 1px;
+ padding-inline-start: 3px;
+ padding-inline-end: 3px;
+ margin-block-start: 0;
+ margin-block-end: -1px;
+ margin-inline-start: -3px;
+ margin-inline-end: -3px;
+ background-color: var(--search-mark-bg);
+ transition: background-color 300ms linear;
+ cursor: pointer;
+}
+
+mark.fade-out {
+ background-color: rgba(0,0,0,0) !important;
+ cursor: auto;
+}
+
+.searchbar-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ padding: 10px 16px;
+ transition: box-shadow 300ms ease-in-out;
+ border: 1px solid var(--searchbar-border-color);
+ border-radius: 3px;
+ background-color: var(--searchbar-bg);
+ color: var(--searchbar-fg);
+}
+#searchbar:focus,
+#searchbar.active {
+ box-shadow: 0 0 3px var(--searchbar-shadow-color);
+}
+
+.searchresults-header {
+ font-weight: bold;
+ font-size: 1em;
+ padding-block-start: 18px;
+ padding-block-end: 0;
+ padding-inline-start: 5px;
+ padding-inline-end: 0;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+ border-block-end: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-inline-start: 20px;
+}
+ul#searchresults li {
+ margin: 10px 0px;
+ padding: 2px;
+ border-radius: 2px;
+}
+ul#searchresults li.focus {
+ background-color: var(--searchresults-li-bg);
+}
+ul#searchresults span.teaser {
+ display: block;
+ clear: both;
+ margin-block-start: 5px;
+ margin-block-end: 0;
+ margin-inline-start: 20px;
+ margin-inline-end: 0;
+ font-size: 0.8em;
+}
+ul#searchresults span.teaser em {
+ font-weight: bold;
+ font-style: normal;
+}
+
+/* Sidebar */
+
+.sidebar {
+ position: fixed;
+ left: 0;
+ top: 0;
+ bottom: 0;
+ width: var(--sidebar-width);
+ font-size: 0.875em;
+ box-sizing: border-box;
+ -webkit-overflow-scrolling: touch;
+ overscroll-behavior-y: contain;
+ background-color: var(--sidebar-bg);
+ color: var(--sidebar-fg);
+}
+[dir=rtl] .sidebar { left: unset; right: 0; }
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.no-js .sidebar,
+.js:not(.sidebar-resizing) .sidebar {
+ transition: transform 0.3s; /* Animation: slide away */
+}
+.sidebar code {
+ line-height: 2em;
+}
+.sidebar .sidebar-scrollbox {
+ overflow-y: auto;
+ position: absolute;
+ top: 0;
+ bottom: 0;
+ left: 0;
+ right: 0;
+ padding: 10px 10px;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: calc(var(--sidebar-resize-indicator-width) * -1);
+ top: 0;
+ bottom: 0;
+ display: flex;
+ align-items: center;
+}
+
+.sidebar-resize-handle .sidebar-resize-indicator {
+ width: 100%;
+ height: 12px;
+ background-color: var(--icons);
+ margin-inline-start: var(--sidebar-resize-indicator-space);
+}
+
+[dir=rtl] .sidebar .sidebar-resize-handle {
+ left: calc(var(--sidebar-resize-indicator-width) * -1);
+ right: unset;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: calc(var(--sidebar-resize-indicator-width) - var(--sidebar-resize-indicator-space));
+}
+/* sidebar-hidden */
+#sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+ z-index: -1;
+}
+[dir=rtl] #sidebar-toggle-anchor:not(:checked) ~ .sidebar {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+/* sidebar-visible */
+#sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width)));
+}
+[dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: translateX(calc(0px - var(--sidebar-width) - var(--sidebar-resize-indicator-width)));
+}
+@media only screen and (min-width: 620px) {
+ #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ margin-inline-start: calc(var(--sidebar-width) + var(--sidebar-resize-indicator-width));
+ }
+ [dir=rtl] #sidebar-toggle-anchor:checked ~ .page-wrapper {
+ transform: none;
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-inline-start: 0;
+ line-height: 2.2em;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ padding: 0;
+ text-decoration: none;
+ color: var(--sidebar-fg);
+}
+
+.chapter li a:hover {
+ color: var(--sidebar-active);
+}
+
+.chapter li a.active {
+ color: var(--sidebar-active);
+}
+
+.chapter li > a.toggle {
+ cursor: pointer;
+ display: block;
+ margin-inline-start: auto;
+ padding: 0 10px;
+ user-select: none;
+ opacity: 0.68;
+}
+
+.chapter li > a.toggle div {
+ transition: transform 0.5s;
+}
+
+/* collapse the section */
+.chapter li:not(.expanded) + li > ol {
+ display: none;
+}
+
+.chapter li.chapter-item {
+ line-height: 1.5em;
+ margin-block-start: 0.6em;
+}
+
+.chapter li.expanded > a.toggle div {
+ transform: rotate(90deg);
+}
+
+.spacer {
+ width: 100%;
+ height: 3px;
+ margin: 5px 0px;
+}
+.chapter .spacer {
+ background-color: var(--sidebar-spacer);
+}
+
+@media (-moz-touch-enabled: 1), (pointer: coarse) {
+ .chapter li a { padding: 5px 0; }
+ .spacer { margin: 10px 0; }
+}
+
+.section {
+ list-style: none outside none;
+ padding-inline-start: 20px;
+ line-height: 1.9em;
+}
+
+/* Theme Menu Popup */
+
+.theme-popup {
+ position: absolute;
+ left: 10px;
+ top: var(--menu-bar-height);
+ z-index: 1000;
+ border-radius: 4px;
+ font-size: 0.7em;
+ color: var(--fg);
+ background: var(--theme-popup-bg);
+ border: 1px solid var(--theme-popup-border);
+ margin: 0;
+ padding: 0;
+ list-style: none;
+ display: none;
+ /* Don't let the children's background extend past the rounded corners. */
+ overflow: hidden;
+}
+[dir=rtl] .theme-popup { left: unset; right: 10px; }
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 20px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: start;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+
+.theme-selected::before {
+ display: inline-block;
+ content: "✓";
+ margin-inline-start: -14px;
+ width: 14px;
+}
diff --git a/master/css/general.css b/master/css/general.css
new file mode 100644
index 00000000..e7d20da7
--- /dev/null
+++ b/master/css/general.css
@@ -0,0 +1,234 @@
+/* Base styles and content styles */
+
+@import 'variables.css';
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+ color-scheme: var(--color-scheme);
+}
+
+html {
+ font-family: "Open Sans", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+}
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: var(--mono-font) !important;
+ font-size: var(--code-font-size);
+ direction: ltr !important;
+}
+
+/* make long words/inline code not x overflow */
+main {
+ overflow-wrap: break-word;
+}
+
+/* make wide tables scroll if they overflow */
+.table-wrapper {
+ overflow-x: auto;
+}
+
+/* Don't change font size in headers. */
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ font-size: unset;
+}
+
+.left { float: left; }
+.right { float: right; }
+.boring { opacity: 0.6; }
+.hide-boring .boring { display: none; }
+.hidden { display: none !important; }
+
+h2, h3 { margin-block-start: 2.5em; }
+h4, h5 { margin-block-start: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-block-start: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-inline-start: -30px;
+ width: 30px;
+}
+
+/* This is broken on Safari as of version 14, but is fixed
+ in Safari Technology Preview 117 which I think will be Safari 14.2.
+ https://bugs.webkit.org/show_bug.cgi?id=218076
+*/
+:target {
+ /* Safari does not support logical properties */
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-block-start: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+ background-color: var(--bg);
+}
+.no-js .page-wrapper,
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+[dir=rtl] .js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-right 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 5px 50px 5px;
+}
+.content main {
+ margin-inline-start: auto;
+ margin-inline-end: auto;
+ max-width: var(--content-max-width);
+}
+.content p { line-height: 1.45em; }
+.content ol { line-height: 1.45em; }
+.content ul { line-height: 1.45em; }
+.content a { text-decoration: none; }
+.content a:hover { text-decoration: underline; }
+.content img, .content video { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+}
+table td {
+ padding: 3px 20px;
+ border: 1px var(--table-border-color) solid;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: 3px 20px;
+}
+table thead tr {
+ border: 1px var(--table-header-bg) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ background: var(--table-alternate-bg);
+}
+
+
+blockquote {
+ margin: 20px 0;
+ padding: 0 20px;
+ color: var(--fg);
+ background-color: var(--quote-bg);
+ border-block-start: .1em solid var(--quote-border);
+ border-block-end: .1em solid var(--quote-border);
+}
+
+.warning {
+ margin: 20px;
+ padding: 0 20px;
+ border-inline-start: 2px solid var(--warning-border);
+}
+
+.warning:before {
+ position: absolute;
+ width: 3rem;
+ height: 3rem;
+ margin-inline-start: calc(-1.5rem - 21px);
+ content: "ⓘ";
+ text-align: center;
+ background-color: var(--bg);
+ color: var(--warning-border);
+ font-weight: bold;
+ font-size: 2rem;
+}
+
+blockquote .warning:before {
+ background-color: var(--quote-bg);
+}
+
+kbd {
+ background-color: var(--table-border-color);
+ border-radius: 4px;
+ border: solid 1px var(--theme-popup-border);
+ box-shadow: inset 0 -1px 0 var(--theme-hover);
+ display: inline-block;
+ font-size: var(--code-font-size);
+ font-family: var(--mono-font);
+ line-height: 10px;
+ padding: 4px 5px;
+ vertical-align: middle;
+}
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-block-start: 2em;
+}
+.footnote-definition {
+ font-size: 0.9em;
+ margin: 0.5em 0;
+}
+.footnote-definition p {
+ display: inline;
+}
+
+.tooltiptext {
+ position: absolute;
+ visibility: hidden;
+ color: #fff;
+ background-color: #333;
+ transform: translateX(-50%); /* Center by moving tooltip 50% of its width left */
+ left: -8px; /* Half of the width of the icon */
+ top: -35px;
+ font-size: 0.8em;
+ text-align: center;
+ border-radius: 6px;
+ padding: 5px 8px;
+ margin: 5px;
+ z-index: 1000;
+}
+.tooltipped .tooltiptext {
+ visibility: visible;
+}
+
+.chapter li.part-title {
+ color: var(--sidebar-fg);
+ margin: 5px 0px;
+ font-weight: bold;
+}
+
+.result-no-output {
+ font-style: italic;
+}
diff --git a/master/css/print.css b/master/css/print.css
new file mode 100644
index 00000000..80ec3a54
--- /dev/null
+++ b/master/css/print.css
@@ -0,0 +1,50 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none !important;
+ margin-inline-start: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ direction: ltr !important;
+}
+
+pre > .buttons {
+ z-index: 2;
+}
+
+a, a:visited, a:active, a:hover {
+ color: #4183c4;
+ text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ page-break-inside: avoid;
+ page-break-after: avoid;
+}
+
+pre, code {
+ page-break-inside: avoid;
+ white-space: pre-wrap;
+}
+
+.fa {
+ display: none !important;
+}
diff --git a/master/css/variables.css b/master/css/variables.css
new file mode 100644
index 00000000..0da55e8c
--- /dev/null
+++ b/master/css/variables.css
@@ -0,0 +1,279 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --sidebar-resize-indicator-width: 8px;
+ --sidebar-resize-indicator-space: 2px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+ --mono-font: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace;
+ --code-font-size: 0.875em /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* Themes */
+
+.ayu {
+ --bg: hsl(210, 25%, 8%);
+ --fg: #c5c5c5;
+
+ --sidebar-bg: #14191f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #5c6773;
+ --sidebar-active: #ffb454;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #0096cf;
+
+ --inline-code-color: #ffb454;
+
+ --theme-popup-bg: #14191f;
+ --theme-popup-border: #5c6773;
+ --theme-hover: #191f26;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(210, 25%, 13%);
+ --table-header-bg: hsl(210, 25%, 28%);
+ --table-alternate-bg: hsl(210, 25%, 11%);
+
+ --searchbar-border-color: #848484;
+ --searchbar-bg: #424242;
+ --searchbar-fg: #fff;
+ --searchbar-shadow-color: #d4c89f;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #252932;
+ --search-mark-bg: #e3b171;
+
+ --color-scheme: dark;
+}
+
+.coal {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+
+ --color-scheme: dark;
+}
+
+.light {
+ --bg: hsl(0, 0%, 100%);
+ --fg: hsl(0, 0%, 0%);
+
+ --sidebar-bg: #fafafa;
+ --sidebar-fg: hsl(0, 0%, 0%);
+ --sidebar-non-existant: #aaaaaa;
+ --sidebar-active: #1f1fff;
+ --sidebar-spacer: #f4f4f4;
+
+ --scrollbar: #8F8F8F;
+
+ --icons: #747474;
+ --icons-hover: #000000;
+
+ --links: #20609f;
+
+ --inline-code-color: #301900;
+
+ --theme-popup-bg: #fafafa;
+ --theme-popup-border: #cccccc;
+ --theme-hover: #e6e6e6;
+
+ --quote-bg: hsl(197, 37%, 96%);
+ --quote-border: hsl(197, 37%, 91%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(0, 0%, 95%);
+ --table-header-bg: hsl(0, 0%, 80%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #e4f2fe;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: light;
+}
+
+.navy {
+ --bg: hsl(226, 23%, 11%);
+ --fg: #bcbdd0;
+
+ --sidebar-bg: #282d3f;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #2b79a2;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: #282e40;
+
+ --quote-bg: hsl(226, 15%, 17%);
+ --quote-border: hsl(226, 15%, 22%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(226, 23%, 16%);
+ --table-header-bg: hsl(226, 23%, 31%);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+
+ --color-scheme: dark;
+}
+
+.rust {
+ --bg: hsl(60, 9%, 87%);
+ --fg: #262625;
+
+ --sidebar-bg: #3b2e2a;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #e69f67;
+ --sidebar-spacer: #45373a;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #262625;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #6e6b5e;
+
+ --theme-popup-bg: #e1e1db;
+ --theme-popup-border: #b38f6b;
+ --theme-hover: #99908a;
+
+ --quote-bg: hsl(60, 5%, 75%);
+ --quote-border: hsl(60, 5%, 70%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(60, 9%, 82%);
+ --table-header-bg: #b3a497;
+ --table-alternate-bg: hsl(60, 9%, 84%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #fafafa;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #888;
+ --searchresults-li-bg: #dec2a2;
+ --search-mark-bg: #e69f67;
+
+ --color-scheme: light;
+}
+
+@media (prefers-color-scheme: dark) {
+ .light.no-js {
+ --bg: hsl(200, 7%, 8%);
+ --fg: #98a3ad;
+
+ --sidebar-bg: #292c2f;
+ --sidebar-fg: #a1adb8;
+ --sidebar-non-existant: #505254;
+ --sidebar-active: #3473ad;
+ --sidebar-spacer: #393939;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #43484d;
+ --icons-hover: #b3c0cc;
+
+ --links: #2b79a2;
+
+ --inline-code-color: #c5c8c6;
+
+ --theme-popup-bg: #141617;
+ --theme-popup-border: #43484d;
+ --theme-hover: #1f2124;
+
+ --quote-bg: hsl(234, 21%, 18%);
+ --quote-border: hsl(234, 21%, 23%);
+
+ --warning-border: #ff8e00;
+
+ --table-border-color: hsl(200, 7%, 13%);
+ --table-header-bg: hsl(200, 7%, 28%);
+ --table-alternate-bg: hsl(200, 7%, 11%);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #b7b7b7;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #666;
+ --searchresults-border-color: #98a3ad;
+ --searchresults-li-bg: #2b2b2f;
+ --search-mark-bg: #355c7d;
+ }
+}
diff --git a/master/custom.css b/master/custom.css
new file mode 100644
index 00000000..4b039125
--- /dev/null
+++ b/master/custom.css
@@ -0,0 +1,231 @@
+html {
+ font-family: "Inter", sans-serif;
+}
+
+.sidebar .sidebar-scrollbox {
+ padding: 0;
+}
+
+.chapter {
+ margin: 0.25rem 0;
+}
+
+.chapter li.chapter-item {
+ line-height: initial;
+ margin: 0;
+ padding: 1rem 1.5rem;
+}
+
+.chapter .section li.chapter-item {
+ line-height: inherit;
+ padding: .5rem .5rem 0 .5rem;
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 15px;
+ padding-bottom: 50px;
+}
+
+/* 2 1.75 1.5 1.25 1 .875 */
+.content h1 { font-size: 2em }
+.content h2 { font-size: 1.75em }
+.content h3 { font-size: 1.5em }
+.content h4 { font-size: 1.25em }
+.content h5 { font-size: 1em }
+.content h6 { font-size: .875em }
+
+.content h1,
+.content h2,
+.content h3,
+.content h4 {
+ font-weight: 500;
+ margin-top: 1.275em;
+ margin-bottom: .875em;
+}
+
+.content p,
+.content ol,
+.content ul,
+.content table {
+ margin-top: 0;
+ margin-bottom: .875em;
+}
+
+.content ul li {
+ margin-bottom: .25rem;
+}
+
+.content ul {
+ list-style-type: square;
+}
+
+.content ul ul,
+.content ol ul {
+ margin-bottom: .5rem;
+}
+
+.content li p {
+ margin-bottom: .5em;
+}
+
+blockquote {
+ margin: 1.5rem 0;
+ padding: 1rem 1.5rem;
+ color: var(--fg);
+ opacity: .9;
+ background-color: var(--quote-bg);
+ border-left: 4px solid var(--quote-border);
+ border-top: none;
+ border-bottom: none;
+}
+
+blockquote *:last-child {
+ margin-bottom: 0;
+}
+
+table {
+ width: 100%;
+}
+
+table thead th {
+ padding: .75rem;
+ text-align: left;
+ font-weight: 500;
+ line-height: 1.5;
+ width: auto;
+}
+
+table td {
+ padding: .75rem;
+ border: none;
+}
+
+table thead tr {
+ border: none;
+ border-bottom: 2px var(--table-border-color) solid;
+}
+
+table tbody tr {
+ border-bottom: 1px var(--table-border-line) solid;
+}
+
+table tbody tr:nth-child(2n) {
+ background: unset;
+}
+
+pre code.hljs {
+ display: block;
+ overflow-x: auto;
+ padding: 1em;
+}
+
+code.hljs {
+ padding: 3px 5px;
+}
+
+.colibri {
+ --bg: #3b224c;
+ --fg: #bcbdd0;
+ --heading-fg: #fff;
+
+ --sidebar-bg: #281733;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existent: #505274;
+ --sidebar-active: #a4a0e8;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ /* --links: #a4a0e8; */
+ --links: #ECCDBA;
+
+ --inline-code-color: hsl(48.7, 7.8%, 70%);
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: rgba(0, 0, 0, .2);
+
+ --quote-bg: #281733;
+ --quote-border: hsl(226, 15%, 22%);
+
+ --table-border-color: hsl(226, 23%, 76%);
+ --table-header-bg: hsla(226, 23%, 31%, 0);
+ --table-alternate-bg: hsl(226, 23%, 14%);
+ --table-border-line: hsla(201deg, 20%, 92%, 0.2);
+
+ --searchbar-border-color: #aaa;
+ --searchbar-bg: #aeaec6;
+ --searchbar-fg: #000;
+ --searchbar-shadow-color: #aaa;
+ --searchresults-header-fg: #5f5f71;
+ --searchresults-border-color: #5c5c68;
+ --searchresults-li-bg: #242430;
+ --search-mark-bg: #a2cff5;
+}
+
+.colibri .content .header {
+ color: #fff;
+}
+
+/* highlight.js theme, :where() is used to avoid increasing specificity */
+
+:where(.colibri) .hljs {
+ background: #2f1e2e;
+ color: #a39e9b;
+}
+
+:where(.colibri) .hljs-comment,
+:where(.colibri) .hljs-quote {
+ color: #8d8687;
+}
+
+:where(.colibri) .hljs-link,
+:where(.colibri) .hljs-meta,
+:where(.colibri) .hljs-name,
+:where(.colibri) .hljs-regexp,
+:where(.colibri) .hljs-selector-class,
+:where(.colibri) .hljs-selector-id,
+:where(.colibri) .hljs-tag,
+:where(.colibri) .hljs-template-variable,
+:where(.colibri) .hljs-variable {
+ color: #ef6155;
+}
+
+:where(.colibri) .hljs-built_in,
+:where(.colibri) .hljs-deletion,
+:where(.colibri) .hljs-literal,
+:where(.colibri) .hljs-number,
+:where(.colibri) .hljs-params,
+:where(.colibri) .hljs-type {
+ color: #f99b15;
+}
+
+:where(.colibri) .hljs-attribute,
+:where(.colibri) .hljs-section,
+:where(.colibri) .hljs-title {
+ color: #fec418;
+}
+
+:where(.colibri) .hljs-addition,
+:where(.colibri) .hljs-bullet,
+:where(.colibri) .hljs-string,
+:where(.colibri) .hljs-symbol {
+ color: #48b685;
+}
+
+:where(.colibri) .hljs-keyword,
+:where(.colibri) .hljs-selector-tag {
+ color: #815ba4;
+}
+
+:where(.colibri) .hljs-emphasis {
+ font-style: italic;
+}
+
+:where(.colibri) .hljs-strong {
+ font-weight: 700;
+}
diff --git a/master/elasticlunr.min.js b/master/elasticlunr.min.js
new file mode 100644
index 00000000..94b20dd2
--- /dev/null
+++ b/master/elasticlunr.min.js
@@ -0,0 +1,10 @@
+/**
+ * elasticlunr - http://weixsong.github.io
+ * Lightweight full-text search engine in Javascript for browser search and offline search. - 0.9.5
+ *
+ * Copyright (C) 2017 Oliver Nightingale
+ * Copyright (C) 2017 Wei Song
+ * MIT Licensed
+ * @license
+ */
+!function(){function e(e){if(null===e||"object"!=typeof e)return e;var t=e.constructor();for(var n in e)e.hasOwnProperty(n)&&(t[n]=e[n]);return t}var t=function(e){var n=new t.Index;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),e&&e.call(n,n),n};t.version="0.9.5",lunr=t,t.utils={},t.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),t.utils.toString=function(e){return void 0===e||null===e?"":e.toString()},t.EventEmitter=function(){this.events={}},t.EventEmitter.prototype.addListener=function(){var e=Array.prototype.slice.call(arguments),t=e.pop(),n=e;if("function"!=typeof t)throw new TypeError("last argument must be a function");n.forEach(function(e){this.hasHandler(e)||(this.events[e]=[]),this.events[e].push(t)},this)},t.EventEmitter.prototype.removeListener=function(e,t){if(this.hasHandler(e)){var n=this.events[e].indexOf(t);-1!==n&&(this.events[e].splice(n,1),0==this.events[e].length&&delete this.events[e])}},t.EventEmitter.prototype.emit=function(e){if(this.hasHandler(e)){var t=Array.prototype.slice.call(arguments,1);this.events[e].forEach(function(e){e.apply(void 0,t)},this)}},t.EventEmitter.prototype.hasHandler=function(e){return e in this.events},t.tokenizer=function(e){if(!arguments.length||null===e||void 0===e)return[];if(Array.isArray(e)){var n=e.filter(function(e){return null===e||void 0===e?!1:!0});n=n.map(function(e){return t.utils.toString(e).toLowerCase()});var i=[];return n.forEach(function(e){var n=e.split(t.tokenizer.seperator);i=i.concat(n)},this),i}return e.toString().trim().toLowerCase().split(t.tokenizer.seperator)},t.tokenizer.defaultSeperator=/[\s\-]+/,t.tokenizer.seperator=t.tokenizer.defaultSeperator,t.tokenizer.setSeperator=function(e){null!==e&&void 0!==e&&"object"==typeof e&&(t.tokenizer.seperator=e)},t.tokenizer.resetSeperator=function(){t.tokenizer.seperator=t.tokenizer.defaultSeperator},t.tokenizer.getSeperator=function(){return t.tokenizer.seperator},t.Pipeline=function(){this._queue=[]},t.Pipeline.registeredFunctions={},t.Pipeline.registerFunction=function(e,n){n in t.Pipeline.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[n]=e},t.Pipeline.getRegisteredFunction=function(e){return e in t.Pipeline.registeredFunctions!=!0?null:t.Pipeline.registeredFunctions[e]},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(e){var i=t.Pipeline.getRegisteredFunction(e);if(!i)throw new Error("Cannot load un-registered function: "+e);n.add(i)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(e){t.Pipeline.warnIfFunctionNotRegistered(e),this._queue.push(e)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i+1,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var i=this._queue.indexOf(e);if(-1===i)throw new Error("Cannot find existingFn");this._queue.splice(i,0,n)},t.Pipeline.prototype.remove=function(e){var t=this._queue.indexOf(e);-1!==t&&this._queue.splice(t,1)},t.Pipeline.prototype.run=function(e){for(var t=[],n=e.length,i=this._queue.length,o=0;n>o;o++){for(var r=e[o],s=0;i>s&&(r=this._queue[s](r,o,e),void 0!==r&&null!==r);s++);void 0!==r&&null!==r&&t.push(r)}return t},t.Pipeline.prototype.reset=function(){this._queue=[]},t.Pipeline.prototype.get=function(){return this._queue},t.Pipeline.prototype.toJSON=function(){return this._queue.map(function(e){return t.Pipeline.warnIfFunctionNotRegistered(e),e.label})},t.Index=function(){this._fields=[],this._ref="id",this.pipeline=new t.Pipeline,this.documentStore=new t.DocumentStore,this.index={},this.eventEmitter=new t.EventEmitter,this._idfCache={},this.on("add","remove","update",function(){this._idfCache={}}.bind(this))},t.Index.prototype.on=function(){var e=Array.prototype.slice.call(arguments);return this.eventEmitter.addListener.apply(this.eventEmitter,e)},t.Index.prototype.off=function(e,t){return this.eventEmitter.removeListener(e,t)},t.Index.load=function(e){e.version!==t.version&&t.utils.warn("version mismatch: current "+t.version+" importing "+e.version);var n=new this;n._fields=e.fields,n._ref=e.ref,n.documentStore=t.DocumentStore.load(e.documentStore),n.pipeline=t.Pipeline.load(e.pipeline),n.index={};for(var i in e.index)n.index[i]=t.InvertedIndex.load(e.index[i]);return n},t.Index.prototype.addField=function(e){return this._fields.push(e),this.index[e]=new t.InvertedIndex,this},t.Index.prototype.setRef=function(e){return this._ref=e,this},t.Index.prototype.saveDocument=function(e){return this.documentStore=new t.DocumentStore(e),this},t.Index.prototype.addDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.addDoc(i,e),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));this.documentStore.addFieldLength(i,n,o.length);var r={};o.forEach(function(e){e in r?r[e]+=1:r[e]=1},this);for(var s in r){var u=r[s];u=Math.sqrt(u),this.index[n].addToken(s,{ref:i,tf:u})}},this),n&&this.eventEmitter.emit("add",e,this)}},t.Index.prototype.removeDocByRef=function(e){if(e&&this.documentStore.isDocStored()!==!1&&this.documentStore.hasDoc(e)){var t=this.documentStore.getDoc(e);this.removeDoc(t,!1)}},t.Index.prototype.removeDoc=function(e,n){if(e){var n=void 0===n?!0:n,i=e[this._ref];this.documentStore.hasDoc(i)&&(this.documentStore.removeDoc(i),this._fields.forEach(function(n){var o=this.pipeline.run(t.tokenizer(e[n]));o.forEach(function(e){this.index[n].removeToken(e,i)},this)},this),n&&this.eventEmitter.emit("remove",e,this))}},t.Index.prototype.updateDoc=function(e,t){var t=void 0===t?!0:t;this.removeDocByRef(e[this._ref],!1),this.addDoc(e,!1),t&&this.eventEmitter.emit("update",e,this)},t.Index.prototype.idf=function(e,t){var n="@"+t+"/"+e;if(Object.prototype.hasOwnProperty.call(this._idfCache,n))return this._idfCache[n];var i=this.index[t].getDocFreq(e),o=1+Math.log(this.documentStore.length/(i+1));return this._idfCache[n]=o,o},t.Index.prototype.getFields=function(){return this._fields.slice()},t.Index.prototype.search=function(e,n){if(!e)return[];e="string"==typeof e?{any:e}:JSON.parse(JSON.stringify(e));var i=null;null!=n&&(i=JSON.stringify(n));for(var o=new t.Configuration(i,this.getFields()).get(),r={},s=Object.keys(e),u=0;u
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Configuration
+To override global configuration parameters, create a config.toml file located in your config directory:
-
+
- Linux and Mac:
~/.config/helix/config.toml
+ - Windows:
%AppData%\helix\config.toml
+
++💡 You can easily open the config file by typing
+:config-openwithin Helix normal mode.
Example config:
+theme = "onedark"
+
+[editor]
+line-number = "relative"
+mouse = false
+
+[editor.cursor-shape]
+insert = "bar"
+normal = "block"
+select = "underline"
+
+[editor.file-picker]
+hidden = false
+You can use a custom configuration file by specifying it with the -c or
+--config command line argument, for example hx -c path/to/custom-config.toml.
+Additionally, you can reload the configuration file by sending the USR1
+signal to the Helix process on Unix operating systems, such as by using the command pkill -USR1 hx.
Finally, you can have a config.toml local to a project by putting it under a .helix directory in your repository.
+Its settings will be merged with the configuration directory config.toml and the built-in configuration.
Editor
+[editor] Section
+| Key | Description | Default |
|---|---|---|
scrolloff | Number of lines of padding around the edge of the screen when scrolling | 5 |
mouse | Enable mouse mode | true |
middle-click-paste | Middle click paste support | true |
scroll-lines | Number of lines to scroll per scroll wheel step | 3 |
shell | Shell to use when running external commands | Unix: ["sh", "-c"]Windows: ["cmd", "/C"] |
line-number | Line number display: absolute simply shows each line's number, while relative shows the distance from the current line. When unfocused or in insert mode, relative will still show absolute line numbers | absolute |
cursorline | Highlight all lines with a cursor | false |
cursorcolumn | Highlight all columns with a cursor | false |
gutters | Gutters to display: Available are diagnostics and diff and line-numbers and spacer, note that diagnostics also includes other features like breakpoints, 1-width padding will be inserted if gutters is non-empty | ["diagnostics", "spacer", "line-numbers", "spacer", "diff"] |
auto-completion | Enable automatic pop up of auto-completion | true |
auto-format | Enable automatic formatting on save | true |
auto-save | Enable automatic saving on the focus moving away from Helix. Requires focus event support from your terminal | false |
idle-timeout | Time in milliseconds since last keypress before idle timers trigger. | 250 |
completion-timeout | Time in milliseconds after typing a word character before completions are shown, set to 5 for instant. | 250 |
preview-completion-insert | Whether to apply completion item instantly when selected | true |
completion-trigger-len | The min-length of word under cursor to trigger autocompletion | 2 |
completion-replace | Set to true to make completions always replace the entire word and not just the part before the cursor | false |
auto-info | Whether to display info boxes | true |
true-color | Set to true to override automatic detection of terminal truecolor support in the event of a false negative | false |
undercurl | Set to true to override automatic detection of terminal undercurl support in the event of a false negative | false |
rulers | List of column positions at which to display the rulers. Can be overridden by language specific rulers in languages.toml file | [] |
bufferline | Renders a line at the top of the editor displaying open buffers. Can be always, never or multiple (only shown if more than one buffer is in use) | never |
color-modes | Whether to color the mode indicator with different colors depending on the mode itself | false |
text-width | Maximum line length. Used for the :reflow command and soft-wrapping if soft-wrap.wrap-at-text-width is set | 80 |
workspace-lsp-roots | Directories relative to the workspace root that are treated as LSP roots. Should only be set in .helix/config.toml | [] |
default-line-ending | The line ending to use for new documents. Can be native, lf, crlf, ff, cr or nel. native uses the platform's native line ending (crlf on Windows, otherwise lf). | native |
insert-final-newline | Whether to automatically insert a trailing line-ending on write if missing | true |
popup-border | Draw border around popup, menu, all, or none | none |
indent-heuristic | How the indentation for a newly inserted line is computed: simple just copies the indentation level from the previous line, tree-sitter computes the indentation based on the syntax tree and hybrid combines both approaches. If the chosen heuristic is not available, a different one will be used as a fallback (the fallback order being hybrid -> tree-sitter -> simple). | hybrid |
jump-label-alphabet | The characters that are used to generate two character jump labels. Characters at the start of the alphabet are used first. | "abcdefghijklmnopqrstuvwxyz" |
initial-mode | The initial mode for newly opened editors. | "normal" |
rainbow-brackets | Whether to render rainbow colors for matching brackets. Requires tree-sitter rainbows.scm queries for the language. | false |
[editor.statusline] Section
+Allows configuring the statusline at the bottom of the editor.
+The configuration distinguishes between three areas of the status line:
+[ ... ... LEFT ... ... | ... ... ... CENTER ... ... ... | ... ... RIGHT ... ... ]
Statusline elements can be defined as follows:
+[editor.statusline]
+left = ["mode", "spinner"]
+center = ["file-name"]
+right = ["diagnostics", "selections", "position", "file-encoding", "file-line-ending", "file-type"]
+separator = "│"
+mode.normal = "NORMAL"
+mode.insert = "INSERT"
+mode.select = "SELECT"
+The [editor.statusline] key takes the following sub-keys:
| Key | Description | Default |
|---|---|---|
left | A list of elements aligned to the left of the statusline | ["mode", "spinner", "file-name", "read-only-indicator", "file-modification-indicator"] |
center | A list of elements aligned to the middle of the statusline | [] |
right | A list of elements aligned to the right of the statusline | ["diagnostics", "selections", "register", "position", "file-encoding"] |
separator | The character used to separate elements in the statusline | "│" |
mode.normal | The text shown in the mode element for normal mode | "NOR" |
mode.insert | The text shown in the mode element for insert mode | "INS" |
mode.select | The text shown in the mode element for select mode | "SEL" |
The following statusline elements can be configured:
+| Key | Description |
|---|---|
mode | The current editor mode (mode.normal/mode.insert/mode.select) |
spinner | A progress spinner indicating LSP activity |
file-name | The path/name of the opened file |
file-absolute-path | The absolute path/name of the opened file |
file-base-name | The basename of the opened file |
file-modification-indicator | The indicator to show whether the file is modified (a [+] appears when there are unsaved changes) |
file-encoding | The encoding of the opened file if it differs from UTF-8 |
file-line-ending | The file line endings (CRLF or LF) |
read-only-indicator | An indicator that shows [readonly] when a file cannot be written |
total-line-numbers | The total line numbers of the opened file |
file-type | The type of the opened file |
diagnostics | The number of warnings and/or errors |
workspace-diagnostics | The number of warnings and/or errors on workspace |
selections | The number of active selections |
primary-selection-length | The number of characters currently in primary selection |
position | The cursor position |
position-percentage | The cursor position as a percentage of the total number of lines |
separator | The string defined in editor.statusline.separator (defaults to "│") |
spacer | Inserts a space between elements (multiple/contiguous spacers may be specified) |
version-control | The current branch name or detached commit hash of the opened workspace |
register | The current selected register |
[editor.lsp] Section
+| Key | Description | Default |
|---|---|---|
enable | Enables LSP integration. Setting to false will completely disable language servers regardless of language settings. | true |
display-messages | Display LSP progress messages below statusline1 | false |
auto-signature-help | Enable automatic popup of signature help (parameter hints) | true |
display-inlay-hints | Display inlay hints2 | false |
display-signature-help-docs | Display docs under signature help popup | true |
snippets | Enables snippet completions. Requires a server restart (:lsp-restart) to take effect after :config-reload/:set. | true |
goto-reference-include-declaration | Include declaration in the goto references popup. | true |
1
+
+By default, a progress spinner is shown in the statusline beside the file path.
+2
+
+You may also have to activate them in the LSP config for them to appear, not just in Helix. Inlay hints in Helix are still being improved on and may be a little bit laggy/janky under some circumstances. Please report any bugs you see so we can fix them!
+[editor.cursor-shape] Section
+Defines the shape of cursor in each mode.
+Valid values for these options are block, bar, underline, or hidden.
++💡 Due to limitations of the terminal environment, only the primary cursor can +change shape.
+
| Key | Description | Default |
|---|---|---|
normal | Cursor shape in normal mode | block |
insert | Cursor shape in insert mode | block |
select | Cursor shape in select mode | block |
[editor.file-picker] Section
+Set options for file picker and global search. Ignoring a file means it is +not visible in the Helix file picker and global search.
+All git related options are only enabled in a git repository.
+| Key | Description | Default |
|---|---|---|
hidden | Enables ignoring hidden files | true |
follow-symlinks | Follow symlinks instead of ignoring them | true |
deduplicate-links | Ignore symlinks that point at files already shown in the picker | true |
parents | Enables reading ignore files from parent directories | true |
ignore | Enables reading .ignore files | true |
git-ignore | Enables reading .gitignore files | true |
git-global | Enables reading global .gitignore, whose path is specified in git's config: core.excludesfile option | true |
git-exclude | Enables reading .git/info/exclude files | true |
max-depth | Set with an integer value for maximum depth to recurse | Unset by default |
Ignore files can be placed locally as .ignore or put in your home directory as ~/.ignore. They support the usual ignore and negative ignore (unignore) rules used in .gitignore files.
Additionally, you can use Helix-specific ignore files by creating a local .helix/ignore file in the current workspace or a global ignore file located in your Helix config directory:
-
+
- Linux and Mac:
~/.config/helix/ignore
+ - Windows:
%AppData%\helix\ignore
+
Example:
+# unignore in file picker and global search
+!.github/
+!.gitignore
+!.gitattributes
+[editor.auto-pairs] Section
+Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a +simple boolean value, or a specific mapping of pairs of single characters.
+To disable auto-pairs altogether, set auto-pairs to false:
[editor]
+auto-pairs = false # defaults to `true`
+The default pairs are (){}[]''""``, but these can be customized by
+setting auto-pairs to a TOML table:
[editor.auto-pairs]
+'(' = ')'
+'{' = '}'
+'[' = ']'
+'"' = '"'
+'`' = '`'
+'<' = '>'
+Additionally, this setting can be used in a language config. Unless
+the editor setting is false, this will override the editor config in
+documents with this language.
Example languages.toml that adds <> and removes ''
[[language]]
+name = "rust"
+
+[language.auto-pairs]
+'(' = ')'
+'{' = '}'
+'[' = ']'
+'"' = '"'
+'`' = '`'
+'<' = '>'
+[editor.search] Section
+Search specific options.
+| Key | Description | Default |
|---|---|---|
smart-case | Enable smart case regex searching (case-insensitive unless pattern contains upper case characters) | true |
wrap-around | Whether the search should wrap after depleting the matches | true |
[editor.whitespace] Section
+Options for rendering whitespace with visible characters. Use :set whitespace.render all to temporarily enable visible whitespace.
| Key | Description | Default |
|---|---|---|
render | Whether to render whitespace. May either be all or none, or a table with sub-keys space, nbsp, nnbsp, tab, and newline | none |
characters | Literal characters to use when rendering whitespace. Sub-keys may be any of tab, space, nbsp, nnbsp, newline or tabpad | See example below |
Example
+[editor.whitespace]
+render = "all"
+# or control each character
+[editor.whitespace.render]
+space = "all"
+tab = "all"
+nbsp = "none"
+nnbsp = "none"
+newline = "none"
+
+[editor.whitespace.characters]
+space = "·"
+nbsp = "⍽"
+nnbsp = "␣"
+tab = "→"
+newline = "⏎"
+tabpad = "·" # Tabs will look like "→···" (depending on tab width)
+[editor.indent-guides] Section
+Options for rendering vertical indent guides.
+| Key | Description | Default |
|---|---|---|
render | Whether to render indent guides | false |
character | Literal character to use for rendering the indent guide | │ |
skip-levels | Number of indent levels to skip | 0 |
rainbow-option | Enum to set rainbow indentations. Options: normal, dim and none. | none |
Example:
+[editor.indent-guides]
+render = true
+character = "╎" # Some characters that work well: "▏", "┆", "┊", "⸽"
+skip-levels = 1
+rainbow-option = "normal"
+[editor.gutters] Section
+For simplicity, editor.gutters accepts an array of gutter types, which will
+use default settings for all gutter components.
[editor]
+gutters = ["diff", "diagnostics", "line-numbers", "spacer"]
+To customize the behavior of gutters, the [editor.gutters] section must
+be used. This section contains top level settings, as well as settings for
+specific gutter components as subsections.
| Key | Description | Default |
|---|---|---|
layout | A vector of gutters to display | ["diagnostics", "spacer", "line-numbers", "spacer", "diff"] |
Example:
+[editor.gutters]
+layout = ["diff", "diagnostics", "line-numbers", "spacer"]
+[editor.gutters.line-numbers] Section
+Options for the line number gutter
+| Key | Description | Default |
|---|---|---|
min-width | The minimum number of characters to use | 3 |
Example:
+[editor.gutters.line-numbers]
+min-width = 1
+[editor.gutters.diagnostics] Section
+Currently unused
+[editor.gutters.diff] Section
+The diff gutter option displays colored bars indicating whether a git diff represents that a line was added, removed or changed.
+These colors are controlled by the theme attributes diff.plus, diff.minus and diff.delta.
Other diff providers will eventually be supported by a future plugin system.
+There are currently no options for this section.
+[editor.gutters.spacer] Section
+Currently unused
+[editor.soft-wrap] Section
+Options for soft wrapping lines that exceed the view width:
+| Key | Description | Default |
|---|---|---|
enable | Whether soft wrapping is enabled. | false |
max-wrap | Maximum free space left at the end of the line. | 20 |
max-indent-retain | Maximum indentation to carry over when soft wrapping a line. | 40 |
wrap-indicator | Text inserted before soft wrapped lines, highlighted with ui.virtual.wrap | ↪ |
wrap-at-text-width | Soft wrap at text-width instead of using the full viewport size. | false |
Example:
+[editor.soft-wrap]
+enable = true
+max-wrap = 25 # increase value to reduce forced mid-word wrapping
+max-indent-retain = 0
+wrap-indicator = "" # set wrap-indicator to "" to hide it
+[editor.smart-tab] Section
+Options for navigating and editing using tab key.
+| Key | Description | Default |
|---|---|---|
enable | If set to true, then when the cursor is in a position with non-whitespace to its left, instead of inserting a tab, it will run move_parent_node_end. If there is only whitespace to the left, then it inserts a tab as normal. With the default bindings, to explicitly insert a tab character, press Shift-tab. | true |
supersede-menu | Normally, when a menu is on screen, such as when auto complete is triggered, the tab key is bound to cycling through the items. This means when menus are on screen, one cannot use the tab key to trigger the smart-tab command. If this option is set to true, the smart-tab command always takes precedence, which means one cannot use the tab key to cycle through menu items. One of the other bindings must be used instead, such as arrow keys or C-n/C-p. | false |
Due to lack of support for S-tab in some terminals, the default keybindings don't fully embrace smart-tab editing experience. If you enjoy smart-tab navigation and a terminal that supports the Enhanced Keyboard protocol, consider setting extra keybindings:
+[keys.normal]
+tab = "move_parent_node_end"
+S-tab = "move_parent_node_start"
+
+[keys.insert]
+S-tab = "move_parent_node_start"
+
+[keys.select]
+tab = "extend_parent_node_end"
+S-tab = "extend_parent_node_start"
+[editor.explorer] Section
+Sets explorer side width and style.
+| Key | Description | Default |
|---|---|---|
column-width | explorer side width | 30 |
position | explorer widget position, left or right | left |
[editor.digraphs] Section
+By default, special characters can be input using the insert_digraphs command, bound to \ in normal mode.
+Custom digraphs can be added to the editor.digraphs section of the config.
[editor.digraphs]
+ka = "か"
+ku = { symbols = "く", description = "The japanese character Ku" }
+shrug = "¯\\_(ツ)_/¯"
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/adding_languages.html b/master/guides/adding_languages.html
new file mode 100644
index 00000000..13781aba
--- /dev/null
+++ b/master/guides/adding_languages.html
@@ -0,0 +1,289 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Migrating from Vim
+Helix's editing model is strongly inspired from Vim and Kakoune, and a notable
+difference from Vim (and the most striking similarity to Kakoune) is that Helix
+follows the selection → action model. This means that whatever you are
+going to act on (a word, a paragraph, a line, etc.) is selected first and the
+action itself (delete, change, yank, etc.) comes second. A cursor is simply a
+single width selection.
See also Kakoune's Migrating from Vim and Helix's Migrating from Vim.
+++ +TODO: Mention textobjects, surround, registers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/indent.html b/master/guides/indent.html
new file mode 100644
index 00000000..25be199a
--- /dev/null
+++ b/master/guides/indent.html
@@ -0,0 +1,563 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adding new languages to Helix
+In order to add a new language to Helix, you will need to follow the steps +below.
+Language configuration
+-
+
- Add a new
[[language]]entry in thelanguages.tomlfile and provide the +necessary configuration for the new language. For more information on +language configuration, refer to the +language configuration section of the documentation. +A new language server can be added by extending the[language-server]table in the same file.
+ - If you are adding a new language or updating an existing language server
+configuration, run the command
cargo xtask docgento update the +Language Support documentation.
+
++💡 If you are adding a new Language Server configuration, make sure to update +the +Language Server Wiki +with the installation instructions.
+
Grammar configuration
+-
+
- If a tree-sitter grammar is available for the new language, add a new
+
[[grammar]]entry to thelanguages.tomlfile.
+ - If you are testing the grammar locally, you can use the
source.pathkey +with an absolute path to the grammar. However, before submitting a pull +request, make sure to switch to usingsource.git.
+
Queries
+-
+
- In order to provide syntax highlighting and indentation for the new language, +you will need to add queries. +
- Create a new directory for the language with the path
+
runtime/queries/<name>/.
+ - Refer to the +tree-sitter website +for more information on writing queries. +
- A list of highlight captures can be found on the themes page. +
++💡 In Helix, the first matching query takes precedence when evaluating +queries, which is different from other editors such as Neovim where the last +matching query supersedes the ones before it. See +this issue +for an example.
+
Common issues
+-
+
- If you encounter errors when running Helix after switching branches, you may
+need to update the tree-sitter grammars. Run the command
hx --grammar fetch+to fetch the grammars andhx --grammar buildto build any out-of-date +grammars.
+ - If a parser is causing a segfault, or you want to remove it, make sure to
+remove the compiled parser located at
runtime/grammars/<name>.so.
+ - If you are attempting to add queries and Helix is unable to locate them, ensure that the environment variable
HELIX_RUNTIMEis set to the location of theruntimefolder you're developing in.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/index.html b/master/guides/index.html
new file mode 100644
index 00000000..0941314e
--- /dev/null
+++ b/master/guides/index.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adding indent queries
+Helix uses tree-sitter to correctly indent new lines. This requires a tree-
+sitter grammar and an indent.scm query file placed in runtime/queries/ {language}/indents.scm. The indentation for a line is calculated by traversing
+the syntax tree from the lowest node at the beginning of the new line (see
+Indent queries). Each of these nodes contributes to the total
+indent when it is captured by the query (in what way depends on the name of
+the capture.
Note that it matters where these added indents begin. For example, +multiple indent level increases that start on the same line only increase +the total indent level by 1. See Capture types.
+By default, Helix uses the hybrid indentation heuristic. This means that
+indent queries are not used to compute the expected absolute indentation of a
+line but rather the expected difference in indentation between the new and an
+already existing line. This difference is then added to the actual indentation
+of the already existing line. Since this makes errors in the indent queries
+harder to find, it is recommended to disable it when testing via
+:set indent-heuristic tree-sitter. The rest of this guide assumes that
+the tree-sitter heuristic is used.
Indent queries
+When Helix is inserting a new line through o, O, or <ret>, to determine
+the indent level for the new line, the query in indents.scm is run on the
+document. The starting position of the query is the end of the line above where
+a new line will be inserted.
For o, the inserted line is the line below the cursor, so that starting
+position of the query is the end of the current line.
+#![allow(unused)] +fn main() { +fn need_hero(some_hero: Hero, life: Life) -> { + matches!(some_hero, Hero { // ←─────────────────╮ + strong: true,//←╮ ↑ ↑ │ + fast: true, // │ │ ╰── query start │ + sure: true, // │ ╰───── cursor ├─ traversal + soon: true, // ╰──────── new line inserted │ start node + }) && // │ +// ↑ │ +// ╰───────────────────────────────────────────────╯ + some_hero > life +} +}
For O, the newly inserted line is the current line, so the starting position
+of the query is the end of the line above the cursor.
+#![allow(unused)] +fn main() { +fn need_hero(some_hero: Hero, life: Life) -> { // ←─╮ + matches!(some_hero, Hero { // ←╮ ↑ │ + strong: true,// ↑ ╭───╯ │ │ + fast: true, // │ │ query start ─╯ │ + sure: true, // ╰───┼ cursor ├─ traversal + soon: true, // ╰ new line inserted │ start node + }) && // │ + some_hero > life // │ +} // ←──────────────────────────────────────────────╯ +}
From this starting node, the syntax tree is traversed up until the root node. +Each indent capture is collected along the way, and then combined according to +their capture types and scopes to a final indent +level for the line.
+Capture types
+-
+
@indent(default scopetail): +Increase the indent level by 1. Multiple occurrences in the same line do not +stack. If there is at least one@indentand one@outdentcapture on the +same line, the indent level isn't changed at all.
+@outdent(default scopeall): +Decrease the indent level by 1. The same rules as for@indentapply.
+@indent.always(default scopetail): +Increase the indent level by 1. Multiple occurrences on the same line do +stack. The final indent level is@indent.always–@outdent.always. If +an@indentand an@indent.alwaysare on the same line, the@indentis +ignored.
+@outdent.always(default scopeall): +Decrease the indent level by 1. The same rules as for@indent.alwaysapply.
+@align(default scopeall): +Align everything inside this node to some anchor. The anchor is given +by the start of the node captured by@anchorin the same pattern. +Every pattern with an@alignshould contain exactly one@anchor. +Indent (and outdent) for nodes below (in terms of their starting line) +the@alignnode is added to the indentation required for alignment.
+@extend: +Extend the range of this node to the end of the line and to lines that are +indented more than the line that this node starts on. This is useful for +languages like Python, where for the purpose of indentation some nodes (like +functions or classes) should also contain indented lines that follow them.
+@extend.prevent-once: +Prevents the first extension of an ancestor of this node. For example, in Python +a return expression always ends the block that it is in. Note that this only +stops the extension of the next@extendcapture. If multiple ancestors are +captured, only the extension of the innermost one is prevented. All other +ancestors are unaffected (regardless of whether the innermost ancestor would +actually have been extended).
+
@indent / @outdent
+Consider this example:
++#![allow(unused)] +fn main() { +fn shout(things: Vec<Thing>) { + // ↑ + // ├───────────────────────╮ indent level + // @indent ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄ + // │ + let it_all = |out| { things.filter(|thing| { // │ 1 + // ↑ ↑ │ + // ├───────────────────────┼─────┼┄┄┄┄┄┄┄┄┄┄┄┄┄┄ + // @indent @indent │ + // │ 2 + thing.can_do_with(out) // │ + })}; // ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄ + //↑↑↑ │ 1 +} //╰┼┴──────────────────────────────────────────────┴┄┄┄┄┄┄┄┄┄┄┄┄┄┄ +// 3x @outdent +}
((block) @indent)
+["}" ")"] @outdent
+Note how on the second line, we have two blocks begin on the same line. In this
+case, since both captures occur on the same line, they are combined and only
+result in a net increase of 1. Also note that the closing }s are part of the
+@indent captures, but the 3 @outdents also combine into 1 and result in that
+line losing one indent level.
@extend / @extend.prevent-once
+For an example of where @extend can be useful, consider Python, which is
+whitespace-sensitive.
]
+ (parenthesized_expression)
+ (function_definition)
+ (class_definition)
+] @indent
+
+class Hero:
+ def __init__(self, strong, fast, sure, soon):# ←─╮
+ self.is_strong = strong # │
+ self.is_fast = fast # ╭─── query start │
+ self.is_sure = sure # │ ╭─ cursor │
+ self.is_soon = soon # │ │ │
+ # ↑ ↑ │ │ │
+ # │ ╰──────╯ │ │
+ # ╰─────────────────────╯ │
+ # ├─ traversal
+ def need_hero(self, life): # │ start node
+ return ( # │
+ self.is_strong # │
+ and self.is_fast # │
+ and self.is_sure # │
+ and self.is_soon # │
+ and self > life # │
+ ) # ←─────────────────────────────────────────╯
+Without braces to catch the scope of the function, the smallest descendant of +the cursor on a line feed ends up being the entire inside of the class. Because +of this, it will miss the entire function node and its indent capture, leading +to an indent level one too small.
+To address this case, @extend tells helix to "extend" the captured node's span
+to the line feed and every consecutive line that has a greater indent level than
+the line of the node.
(parenthesized_expression) @indent
+
+]
+ (function_definition)
+ (class_definition)
+] @indent @extend
+
+class Hero:
+ def __init__(self, strong, fast, sure, soon):# ←─╮
+ self.is_strong = strong # │
+ self.is_fast = fast # ╭─── query start ├─ traversal
+ self.is_sure = sure # │ ╭─ cursor │ start node
+ self.is_soon = soon # │ │ ←───────────────╯
+ # ↑ ↑ │ │
+ # │ ╰──────╯ │
+ # ╰─────────────────────╯
+ def need_hero(self, life):
+ return (
+ self.is_strong
+ and self.is_fast
+ and self.is_sure
+ and self.is_soon
+ and self > life
+ )
+Furthermore, there are some cases where extending to everything with a greater
+indent level may not be desirable. Consider the need_hero function above. If
+our cursor is on the last line of the returned expression.
class Hero:
+ def __init__(self, strong, fast, sure, soon):
+ self.is_strong = strong
+ self.is_fast = fast
+ self.is_sure = sure
+ self.is_soon = soon
+
+ def need_hero(self, life):
+ return (
+ self.is_strong
+ and self.is_fast
+ and self.is_sure
+ and self.is_soon
+ and self > life
+ ) # ←─── cursor
+ #←────────── where cursor should go on new line
+In Python, the are a few tokens that will always end a scope, such as a return
+statement. Since the scope ends, so should the indent level. But because the
+function span is extended to every line with a greater indent level, a new line
+would just continue on the same level. And an @outdent would not help us here
+either, since it would cause everything in the parentheses to become outdented
+as well.
To help, we need to signal an end to the extension. We can do this with
+@extend.prevent-once.
(parenthesized_expression) @indent
+
+]
+ (function_definition)
+ (class_definition)
+] @indent @extend
+
+(return_statement) @extend.prevent-once
+@indent.always / @outdent.always
+As mentioned before, normally if there is more than one @indent or @outdent
+capture on the same line, they are combined.
Sometimes, there are cases when you may want to ensure that every indent capture +is additive, regardless of how many occur on the same line. Consider this +example in YAML.
+ - foo: bar
+# ↑ ↑
+# │ ╰─────────────── start of map
+# ╰───────────────── start of list element
+ baz: quux # ←─── cursor
+ # ←───────────── where the cursor should go on a new line
+ garply: waldo
+ - quux:
+ bar: baz
+ xyzzy: thud
+ fred: plugh
+In YAML, you often have lists of maps. In these cases, the syntax is such that
+the list element and the map both start on the same line. But we really do want
+to start an indentation for each of these so that subsequent keys in the map
+hang over the list and align properly. This is where @indent.always helps.
((block_sequence_item) @item @indent.always @extend
+ (#not-one-line? @item))
+
+((block_mapping_pair
+ key: (_) @key
+ value: (_) @val
+ (#not-same-line? @key @val)
+ ) @indent.always @extend
+)
+Predicates
+In some cases, an S-expression cannot express exactly what pattern should be matched.
+For that, tree-sitter allows for predicates to appear anywhere within a pattern,
+similar to how #set! declarations work:
(some_kind
+ (child_kind) @indent
+ (#predicate? arg1 arg2 ...)
+)
+The number of arguments depends on the predicate that's used.
+Each argument is either a capture (@name) or a string ("some string").
+The following predicates are supported by tree-sitter:
-
+
-
+
+#eq?/#not-eq?: +The first argument (a capture) must/must not be equal to the second argument +(a capture or a string).
+ -
+
+#match?/#not-match?: +The first argument (a capture) must/must not match the regex given in the +second argument (a string).
+ -
+
+#any-of?/#not-any-of?: +The first argument (a capture) must/must not be one of the other arguments +(strings).
+
Additionally, we support some custom predicates for indent queries:
+-
+
-
+
+#not-kind-eq?: +The kind of the first argument (a capture) must not be equal to the second +argument (a string).
+ -
+
+#same-line?/#not-same-line?: +The captures given by the 2 arguments must/must not start on the same line.
+ -
+
+#one-line?/#not-one-line?: +The captures given by the fist argument must/must span a total of one line.
+
Scopes
+Added indents don't always apply to the whole node. For example, in most +cases when a node should be indented, we actually only want everything +except for its first line to be indented. For this, there are several +scopes (more scopes may be added in the future if required):
+-
+
tail: +This scope applies to everything except for the first line of the +captured node.
+all: +This scope applies to the whole captured node. This is only different from +tailwhen the captured node is the first node on its line.
+
For example, imagine we have the following function
++#![allow(unused)] +fn main() { +fn aha() { // ←─────────────────────────────────────╮ + let take = "on me"; // ←──────────────╮ scope: │ + let take = "me on"; // ├─ "tail" ├─ (block) @indent + let ill = be_gone_days(1 || 2); // │ │ +} // ←───────────────────────────────────┴──────────┴─ "}" @outdent + // scope: "all" +}
We can write the following query with the #set! declaration:
((block) @indent
+ (#set! "scope" "tail"))
+("}" @outdent
+ (#set! "scope" "all"))
+As we can see, the "tail" scope covers the node, except for the first line.
+Everything up to and including the closing brace gets an indent level of 1.
+Then, on the closing brace, we encounter an outdent with a scope of "all", which
+means the first line is included, and the indent level is cancelled out on this
+line. (Note these scopes are the defaults for @indent and @outdent—they are
+written explicitly for demonstration.)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/injection.html b/master/guides/injection.html
new file mode 100644
index 00000000..f4fe238b
--- /dev/null
+++ b/master/guides/injection.html
@@ -0,0 +1,302 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Guides
+This section contains guides for adding new language server configurations, +tree-sitter grammars, textobject and rainbow bracket queries, and other similar items.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/rainbow_bracket_queries.html b/master/guides/rainbow_bracket_queries.html
new file mode 100644
index 00000000..c64d737c
--- /dev/null
+++ b/master/guides/rainbow_bracket_queries.html
@@ -0,0 +1,323 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adding Injection Queries
+Writing language injection queries allows one to highlight a specific node as a different language. +In addition to the standard language injection options used by tree-sitter, there +are a few Helix specific extensions that allow for more control.
+And example of a simple query that would highlight all strings as bash in Nix:
+((string_expression (string_fragment) @injection.content)
+ (#set! injection.language "bash"))
+Capture Types
+-
+
-
+
+@injection.language(standard): +The captured node may contain the language name used to highlight the node captured by +@injection.content.
+ -
+
+@injection.content(standard): +Marks the content to be highlighted as the language captured with@injection.languageet al.
+ -
+
+@injection.filename(extension): +The captured node may contain a filename with a file-extension known to Helix, +highlighting@injection.contentas that language. This uses the language extensions defined in +both the default languages.toml distributed with Helix, as well as user defined languages.
+ -
+
+@injection.shebang(extension): +The captured node may contain a shebang used to choose a language to highlight as. This also uses +the shebangs defined in the default and userlanguages.toml.
+
Settings
+-
+
-
+
+injection.combined(standard): +Indicates that all the matching nodes in the tree should have their content parsed as one +nested document.
+ -
+
+injection.language(standard): +Forces the captured content to be highlighted as the given language
+ -
+
+injection.include-children(standard): +Indicates that the content node’s entire text should be re-parsed, including the text of its child +nodes. By default, child nodes’ text will be excluded from the injected document.
+ -
+
+injection.include-unnamed-children(extension): +Same asinjection.include-childrenbut only for unnamed child nodes.
+
Predicates
+-
+
-
+
+#eq?(standard): +The first argument (a capture) must be equal to the second argument +(a capture or a string).
+ -
+
+#match?(standard): +The first argument (a capture) must match the regex given in the +second argument (a string).
+ -
+
+#any-of?(standard): +The first argument (a capture) must be one of the other arguments (strings).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/textobject.html b/master/guides/textobject.html
new file mode 100644
index 00000000..d67f0dda
--- /dev/null
+++ b/master/guides/textobject.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adding Rainbow Bracket Queries
+Helix uses rainbows.scm tree-sitter query files to provide rainbow bracket
+functionality.
Tree-sitter queries are documented in the tree-sitter online documentation. +If you're writing queries for the first time, be sure to check out the section +on syntax highlighting queries and on query syntax.
+Rainbow queries have two captures: @rainbow.scope and @rainbow.bracket.
+@rainbow.scope should capture any node that increases the nesting level
+while @rainbow.bracket should capture any bracket nodes. Put another way:
+@rainbow.scope switches to the next rainbow color for all nodes in the tree
+under it while @rainbow.bracket paints captured nodes with the current
+rainbow color.
For an example, let's add rainbow queries for the tree-sitter query (TSQ)
+language itself. These queries will go into a
+runtime/queries/tsq/rainbows.scm file in the repository root.
First we'll add the @rainbow.bracket captures. TSQ only has parentheses and
+square brackets:
["(" ")" "[" "]"] @rainbow.bracket
+The ordering of the nodes within the alternation (square brackets) is not +taken into consideration.
+++Note: Why are these nodes quoted? Most syntax highlights capture text +surrounded by parentheses. These are named nodes and correspond to the +names of rules in the grammar. Brackets are usually written in tree-sitter +grammars as literal strings, for example:
++{ + // ... + arguments: seq("(", repeat($.argument), ")"), + // ... +} +Nodes written as literal strings in tree-sitter grammars may be captured +in queries with those same literal strings.
+
Then we'll add @rainbow.scope captures. The easiest way to do this is to
+view the grammar.js file in the tree-sitter grammar's repository. For TSQ,
+that file is here. As we scroll down the grammar.js, we
+see that the (alternation), (L36) (group) (L57), (named_node) (L59),
+(predicate) (L87) and (wildcard_node) (L97) nodes all contain literal
+parentheses or square brackets in their definitions. These nodes are all
+direct parents of brackets and happen to also be the nodes we want to change
+to the next rainbow color, so we capture them as @rainbow.scope.
[
+ (group)
+ (named_node)
+ (wildcard_node)
+ (predicate)
+ (alternation)
+] @rainbow.scope
+This strategy works as a rule of thumb for most programming and configuration +languages. Markup languages can be trickier and may take additional +experimentation to find the correct nodes to use for scopes and brackets.
+The :tree-sitter-subtree command shows the syntax tree under the primary
+selection in S-expression format and can be a useful tool for determining how
+to write a query.
Properties
+The rainbow.include-children property may be applied to @rainbow.scope
+captures. By default, all @rainbow.bracket captures must be direct descendant
+of a node captured with @rainbow.scope in a syntax tree in order to be
+highlighted. The rainbow.include-children property disables that check and
+allows @rainbow.bracket captures to be highlighted if they are direct or
+indirect descendants of some node captured with @rainbow.scope.
For example, this property is used in the HTML rainbow queries.
+For a document like <a>link</a>, the syntax tree is:
(element ; <a>link</a>
+ (start_tag ; <a>
+ (tag_name)) ; a
+ (text) ; link
+ (end_tag ; </a>
+ (tag_name))) ; a
+If we want to highlight the <, > and </ nodes with rainbow colors, we
+capture them as @rainbow.bracket:
["<" ">" "</"] @rainbow.bracket
+And we capture (element) as @rainbow.scope because (element) nodes nest
+within each other: they increment the nesting level and switch to the next
+color in the rainbow.
(element) @rainbow.scope
+But this combination of @rainbow.scope and @rainbow.bracket will not
+highlight any nodes. <, > and </ are children of the (start_tag) and
+(end_tag) nodes. We can't capture (start_tag) and (end_tag) as
+@rainbow.scope because they don't nest other elements. We can fix this case
+by removing the requirement that <, > and </ are direct descendants of
+(element) using the rainbow.include-children property.
((element) @rainbow.scope
+ (#set! rainbow.include-children))
+With this property set, <, >, and </ will highlight with rainbow colors
+even though they aren't direct descendents of the (element) node.
rainbow.include-children is not necessary for the vast majority of programming
+languages. It is only necessary when the node that increments the nesting level
+(changes rainbow color) is not the direct parent of the bracket node.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/highlight.css b/master/highlight.css
new file mode 100644
index 00000000..ba57b82b
--- /dev/null
+++ b/master/highlight.css
@@ -0,0 +1,82 @@
+/*
+ * An increased contrast highlighting scheme loosely based on the
+ * "Base16 Atelier Dune Light" theme by Bram de Haan
+ * (http://atelierbram.github.io/syntax-highlighting/atelier-schemes/dune)
+ * Original Base16 color scheme by Chris Kempson
+ * (https://github.com/chriskempson/base16)
+ */
+
+/* Comment */
+.hljs-comment,
+.hljs-quote {
+ color: #575757;
+}
+
+/* Red */
+.hljs-variable,
+.hljs-template-variable,
+.hljs-attribute,
+.hljs-tag,
+.hljs-name,
+.hljs-regexp,
+.hljs-link,
+.hljs-name,
+.hljs-selector-id,
+.hljs-selector-class {
+ color: #d70025;
+}
+
+/* Orange */
+.hljs-number,
+.hljs-meta,
+.hljs-built_in,
+.hljs-builtin-name,
+.hljs-literal,
+.hljs-type,
+.hljs-params {
+ color: #b21e00;
+}
+
+/* Green */
+.hljs-string,
+.hljs-symbol,
+.hljs-bullet {
+ color: #008200;
+}
+
+/* Blue */
+.hljs-title,
+.hljs-section {
+ color: #0030f2;
+}
+
+/* Purple */
+.hljs-keyword,
+.hljs-selector-tag {
+ color: #9d00ec;
+}
+
+.hljs {
+ display: block;
+ overflow-x: auto;
+ background: #f6f7f6;
+ color: #000;
+}
+
+.hljs-emphasis {
+ font-style: italic;
+}
+
+.hljs-strong {
+ font-weight: bold;
+}
+
+.hljs-addition {
+ color: #22863a;
+ background-color: #f0fff4;
+}
+
+.hljs-deletion {
+ color: #b31d28;
+ background-color: #ffeef0;
+}
diff --git a/master/highlight.js b/master/highlight.js
new file mode 100644
index 00000000..3256c00e
--- /dev/null
+++ b/master/highlight.js
@@ -0,0 +1,53 @@
+/*
+ Highlight.js 10.1.1 (93fd0d73)
+ License: BSD-3-Clause
+ Copyright (c) 2006-2020, Ivan Sagalaev
+*/
+var hljs=function(){"use strict";function e(n){Object.freeze(n);var t="function"==typeof n;return Object.getOwnPropertyNames(n).forEach((function(r){!Object.hasOwnProperty.call(n,r)||null===n[r]||"object"!=typeof n[r]&&"function"!=typeof n[r]||t&&("caller"===r||"callee"===r||"arguments"===r)||Object.isFrozen(n[r])||e(n[r])})),n}class n{constructor(e){void 0===e.data&&(e.data={}),this.data=e.data}ignoreMatch(){this.ignore=!0}}function t(e){return e.replace(/&/g,"&").replace(//g,">").replace(/"/g,""").replace(/'/g,"'")}function r(e,...n){var t={};for(const n in e)t[n]=e[n];return n.forEach((function(e){for(const n in e)t[n]=e[n]})),t}function a(e){return e.nodeName.toLowerCase()}var i=Object.freeze({__proto__:null,escapeHTML:t,inherit:r,nodeStream:function(e){var n=[];return function e(t,r){for(var i=t.firstChild;i;i=i.nextSibling)3===i.nodeType?r+=i.nodeValue.length:1===i.nodeType&&(n.push({event:"start",offset:r,node:i}),r=e(i,r),a(i).match(/br|hr|img|input/)||n.push({event:"stop",offset:r,node:i}));return r}(e,0),n},mergeStreams:function(e,n,r){var i=0,s="",o=[];function l(){return e.length&&n.length?e[0].offset!==n[0].offset?e[0].offset
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adding textobject queries
+Helix supports textobjects that are language specific, such as functions, classes, etc.
+These textobjects require an accompanying tree-sitter grammar and a textobjects.scm query file
+to work properly. Tree-sitter allows us to query the source code syntax tree
+and capture specific parts of it. The queries are written in a lisp dialect.
+More information on how to write queries can be found in the official tree-sitter
+documentation.
Query files should be placed in runtime/queries/{language}/textobjects.scm
+when contributing to Helix. Note that to test the query files locally you should put
+them under your local runtime directory (~/.config/helix/runtime on Linux
+for example).
The following captures are recognized:
+| Capture Name |
|---|
function.inside |
function.around |
class.inside |
class.around |
test.inside |
test.around |
parameter.inside |
comment.inside |
comment.around |
Example query files can be found in the helix GitHub repository.
+Queries for textobject based navigation
+Tree-sitter based navigation in Helix is done using captures in the +following order:
+-
+
object.movement
+object.around
+object.inside
+
For example if a function.around capture has been already defined for a language
+in its textobjects.scm file, function navigation should also work automatically.
+function.movement should be defined only if the node captured by function.around
+doesn't make sense in a navigation context.
":e:f.tabReplace?e.replace(/\t/g,f.tabReplace):e):e}function E(e){let n=null;const t=function(e){var n=e.className+" ";n+=e.parentNode?e.parentNode.className:"";const t=f.languageDetectRe.exec(n);if(t){var r=T(t[1]);return r||(console.warn(g.replace("{}",t[1])),console.warn("Falling back to no-highlight mode for this block.",e)),r?t[1]:"no-highlight"}return n.split(/\s+/).find(e=>p(e)||T(e))}(e);if(p(t))return;S("before:highlightBlock",{block:e,language:t}),f.useBR?(n=document.createElement("div")).innerHTML=e.innerHTML.replace(/\n/g,"").replace(/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/install.html b/master/install.html
new file mode 100644
index 00000000..2c6f3b2e
--- /dev/null
+++ b/master/install.html
@@ -0,0 +1,493 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Helix
+Docs for bleeding edge master can be found at +https://docs.helix-editor.com/master.
+See the usage section for a quick overview of the editor, keymap +section for all available keybindings and the configuration section +for defining custom keybindings, setting themes, etc. +For everything else (e.g., how to install supported language servers), see the Helix Wiki.
+Refer the FAQ for common questions.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/keymap.html b/master/keymap.html
new file mode 100644
index 00000000..828eeb94
--- /dev/null
+++ b/master/keymap.html
@@ -0,0 +1,666 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installing Helix
+ +-
+
- Pre-built binaries +
- Linux, macOS, Windows and OpenBSD packaging status +
- Linux
+
-
+
- Ubuntu +
- Fedora/RHEL +
- Arch Linux extra +
- NixOS +
- Flatpak +
- Snap +
- AppImage +
+ - macOS + + +
- Windows
+
-
+
- Winget +
- Scoop +
- Chocolatey +
- MSYS2 +
+ - Building from source + + +
To install Helix, follow the instructions specific to your operating system. +Note that:
+-
+
-
+
To get the latest nightly version of Helix, you need to +build from source.
+
+ -
+
To take full advantage of Helix, install the language servers for your +preferred programming languages. See the +wiki +for instructions.
+
+
Pre-built binaries
+Download pre-built binaries from the
+GitHub Releases page. Add the binary to your system's $PATH to use it from the command
+line.
Linux, macOS, Windows and OpenBSD packaging status
+
Linux
+The following third party repositories are available:
+Ubuntu
+Add the PPA for Helix:
sudo add-apt-repository ppa:maveonair/helix-editor
+sudo apt update
+sudo apt install helix
+Fedora/RHEL
+sudo dnf install helix
+Arch Linux extra
+Releases are available in the extra repository:
sudo pacman -S helix
+++💡 When installed from the
+extrarepository, run Helix withhelixinstead ofhx.For example:
++helix --health +to check health
+
Additionally, a helix-git package is available +in the AUR, which builds the master branch.
+NixOS
+Helix is available in nixpkgs through the helix attribute,
+the unstable channel usually carries the latest release.
Helix is also available as a flake in the project
+root. Use nix develop to spin up a reproducible development shell. Outputs are
+cached for each push to master using Cachix. The
+flake is configured to automatically make use of this cache assuming the user
+accepts the new settings on first use.
If you are using a version of Nix without flakes enabled,
+install Cachix CLI and use
+cachix use helix to configure Nix to use cached outputs when possible.
Flatpak
+Helix is available on Flathub:
+flatpak install flathub com.helix_editor.Helix
+flatpak run com.helix_editor.Helix
+Snap
+Helix is available on Snapcraft and can be installed with:
+snap install --classic helix
+This will install Helix as both /snap/bin/helix and /snap/bin/hx, so make sure /snap/bin is in your PATH.
AppImage
+Install Helix using the Linux AppImage format. +Download the official Helix AppImage from the latest releases page.
+chmod +x helix-*.AppImage # change permission for executable mode
+./helix-*.AppImage # run helix
+macOS
+Homebrew Core
+brew install helix
+MacPorts
+port install helix
+Windows
+Install on Windows using Winget, Scoop, Chocolatey +or MSYS2.
+Winget
+Windows Package Manager winget command-line tool is by default available on Windows 11 and modern versions of Windows 10 as a part of the App Installer. +You can get App Installer from the Microsoft Store. If it's already installed, make sure it is updated with the latest version.
+winget install Helix.Helix
+Scoop
+scoop install helix
+Chocolatey
+choco install helix
+MSYS2
+For 64-bit Windows 8.1 or above:
+pacman -S mingw-w64-ucrt-x86_64-helix
+Building from source
+Requirements:
+Clone the Helix GitHub repository into a directory of your choice. The
+examples in this documentation assume installation into either ~/src/ on
+Linux and macOS, or %userprofile%\src\ on Windows.
-
+
- The Rust toolchain +
- The Git version control system +
- A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang +
If you are using the musl-libc standard library instead of glibc the following environment variable must be set during the build to ensure tree-sitter grammars can be loaded correctly:
RUSTFLAGS="-C target-feature=-crt-static"
+-
+
-
+
Clone the repository:
+
+git clone https://github.com/helix-editor/helix +cd helix +
+ -
+
Compile from source:
+
+cargo install --path helix-term --locked +This command will create the
+hxexecutable and construct the tree-sitter +grammars in the localruntimefolder.
+
++💡 If you do not want to fetch or build grammars, set an environment variable
+HELIX_DISABLE_AUTO_GRAMMAR_BUILD
++💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch +grammars with
+hx --grammar fetchand compile them with +hx --grammar build. This will install them in +theruntimedirectory within the user's helix config directory (more +details below).
Configuring Helix's runtime files
+Linux and macOS
+The runtime directory is one below the Helix source, so either export a
+HELIX_RUNTIME environment variable to point to that directory and add it to
+your ~/.bashrc or equivalent:
export HELIX_RUNTIME=~/src/helix/runtime
+Or, create a symbolic link:
+ln -Ts $PWD/runtime ~/.config/helix/runtime
+If the above command fails to create a symbolic link because the file exists either move ~/.config/helix/runtime to a new location or delete it, then run the symlink command above again.
Windows
+Either set the HELIX_RUNTIME environment variable to point to the runtime files using the Windows setting (search for
+Edit environment variables for your account) or use the setx command in
+Cmd:
setx HELIX_RUNTIME "%userprofile%\source\repos\helix\runtime"
+++💡
+%userprofile%resolves to your user directory like +C:\Users\Your-Name\for example.
Or, create a symlink in %appdata%\helix\ that links to the source code directory:
| Method | Command |
|---|---|
| PowerShell | New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime" |
| Cmd | cd %appdata%\helix mklink /D runtime "%userprofile%\src\helix\runtime" |
++💡 On Windows, creating a symbolic link may require running PowerShell or +Cmd as an administrator.
+
Multiple runtime directories
+When Helix finds multiple runtime directories it will search through them for files in the +following order:
+-
+
runtime/sibling directory to$CARGO_MANIFEST_DIRdirectory (this is intended for +developing and testing helix only).
+runtime/subdirectory of OS-dependent helix user config directory.
+$HELIX_RUNTIME
+- Distribution-specific fallback directory (set at compile time—not run time—
+with the
HELIX_DEFAULT_RUNTIMEenvironment variable)
+ runtime/subdirectory of path to Helix executable.
+
This order also sets the priority for selecting which file will be used if multiple runtime +directories have files with the same name.
+Note to packagers
+If you are making a package of Helix for end users, to provide a good out of
+the box experience, you should set the HELIX_DEFAULT_RUNTIME environment
+variable at build time (before invoking cargo build) to a directory which
+will store the final runtime files after installation. For example, say you want
+to package the runtime into /usr/lib/helix/runtime. The rough steps a build
+script could follow are:
-
+
export HELIX_DEFAULT_RUNTIME=/usr/lib/helix/runtime
+cargo build --profile opt --locked --path helix-term
+cp -r runtime $BUILD_DIR/usr/lib/helix/
+cp target/opt/hx $BUILD_DIR/usr/bin/hx
+
This way the resulting hx binary will always look for its runtime directory in
+/usr/lib/helix/runtime if the user has no custom runtime in ~/.config/helix
+or HELIX_RUNTIME.
Validating the installation
+To make sure everything is set up as expected you should run the Helix health +check:
+hx --health
+For more information on the health check results refer to +Health check.
+Configure the desktop shortcut
+If your desktop environment supports the
+XDG desktop menu
+you can configure Helix to show up in the application menu by copying the
+provided .desktop and icon files to their correct folders:
cp contrib/Helix.desktop ~/.local/share/applications
+cp contrib/helix.png ~/.icons # or ~/.local/share/icons
+To use another terminal than the system default, you can modify the .desktop
+file. For example, to use kitty:
sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
+sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/lang-support.html b/master/lang-support.html
new file mode 100644
index 00000000..54b7e755
--- /dev/null
+++ b/master/lang-support.html
@@ -0,0 +1,455 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keymap
+-
+
- Normal mode
+
-
+
- Movement +
- Changes
+
-
+
- Shell +
+ - Selection manipulation +
- Search +
- Minor modes
+
-
+
- View mode +
- Goto mode +
- Match mode +
- Window mode +
- Space mode
+
-
+
- Comment mode +
- Popup +
+ - Unimpaired +
+
+ - Insert mode +
- Select / extend mode +
- Picker +
- Prompt +
++💡 Mappings marked (LSP) require an active language server for the file.
+
++💡 Mappings marked (TS) require a tree-sitter grammar for the file type.
+
Normal mode
+Normal mode is the default mode when you launch helix. You can return to it from other modes by pressing the Escape key.
Movement
+++NOTE: Unlike Vim,
+f,F,tandTare not confined to the current line.
| Key | Description | Command |
|---|---|---|
h, Left | Move left | move_char_left |
j, Down | Move down | move_visual_line_down |
k, Up | Move up | move_visual_line_up |
l, Right | Move right | move_char_right |
w | Move next word start | move_next_word_start |
b | Move previous word start | move_prev_word_start |
e | Move next word end | move_next_word_end |
W | Move next WORD start | move_next_long_word_start |
B | Move previous WORD start | move_prev_long_word_start |
E | Move next WORD end | move_next_long_word_end |
t | Find 'till next char | find_till_char |
f | Find next char | find_next_char |
T | Find 'till previous char | till_prev_char |
F | Find previous char | find_prev_char |
G | Go to line number <n> | goto_line |
Alt-. | Repeat last motion (f, t, m, [ or ]) | repeat_last_motion |
Home | Move to the start of the line | goto_line_start |
End | Move to the end of the line | goto_line_end |
Ctrl-b, PageUp | Move page up | page_up |
Ctrl-f, PageDown | Move page down | page_down |
Ctrl-u | Move cursor and page half page up | page_cursor_half_up |
Ctrl-d | Move cursor and page half page down | page_cursor_half_down |
Ctrl-i | Jump forward on the jumplist | jump_forward |
Ctrl-o | Jump backward on the jumplist | jump_backward |
Ctrl-s | Save the current selection to the jumplist | save_selection |
Changes
+| Key | Description | Command |
|---|---|---|
r | Replace with a character | replace |
R | Replace with yanked text | replace_with_yanked |
~ | Switch case of the selected text | switch_case |
` | Set the selected text to lower case | switch_to_lowercase |
Alt-` | Set the selected text to upper case | switch_to_uppercase |
i | Insert before selection | insert_mode |
a | Insert after selection (append) | append_mode |
I | Insert at the start of the line | insert_at_line_start |
A | Insert at the end of the line | insert_at_line_end |
\ | Insert digraphs | insert_digraph |
o | Open new line below selection | open_below |
O | Open new line above selection | open_above |
. | Repeat last insert | N/A |
u | Undo change | undo |
U | Redo change | redo |
Alt-u | Move backward in history | earlier |
Alt-U | Move forward in history | later |
y | Yank selection | yank |
p | Paste after selection | paste_after |
P | Paste before selection | paste_before |
" <reg> | Select a register to yank to or paste from | select_register |
> | Indent selection | indent |
< | Unindent selection | unindent |
= | Format selection (currently nonfunctional/disabled) (LSP) | format_selections |
d | Delete selection | delete_selection |
Alt-d | Delete selection, without yanking | delete_selection_noyank |
c | Change selection (delete and enter insert mode) | change_selection |
Alt-c | Change selection (delete and enter insert mode, without yanking) | change_selection_noyank |
Ctrl-a | Increment object (number) under cursor | increment |
Ctrl-x | Decrement object (number) under cursor | decrement |
Q | Start/stop macro recording to the selected register (experimental) | record_macro |
q | Play back a recorded macro from the selected register (experimental) | replay_macro |
Shell
+| Key | Description | Command |
|---|---|---|
| | Pipe each selection through shell command, replacing with output | shell_pipe |
Alt-| | Pipe each selection into shell command, ignoring output | shell_pipe_to |
! | Run shell command, inserting output before each selection | shell_insert_output |
Alt-! | Run shell command, appending output after each selection | shell_append_output |
$ | Pipe each selection into shell command, keep selections where command returned 0 | shell_keep_pipe |
Selection manipulation
+| Key | Description | Command |
|---|---|---|
s | Select all regex matches inside selections | select_regex |
S | Split selection into sub selections on regex matches | split_selection |
Alt-s | Split selection on newlines | split_selection_on_newline |
Alt-minus | Merge selections | merge_selections |
Alt-_ | Merge consecutive selections | merge_consecutive_selections |
& | Align selection in columns | align_selections |
_ | Trim whitespace from the selection | trim_selections |
; | Collapse selection onto a single cursor | collapse_selection |
Alt-; | Flip selection cursor and anchor | flip_selections |
Alt-: | Ensures the selection is in forward direction | ensure_selections_forward |
, | Keep only the primary selection | keep_primary_selection |
Alt-, | Remove the primary selection | remove_primary_selection |
C | Copy selection onto the next line (Add cursor below) | copy_selection_on_next_line |
Alt-C | Copy selection onto the previous line (Add cursor above) | copy_selection_on_prev_line |
( | Rotate main selection backward | rotate_selections_backward |
) | Rotate main selection forward | rotate_selections_forward |
Alt-( | Rotate selection contents backward | rotate_selection_contents_backward |
Alt-) | Rotate selection contents forward | rotate_selection_contents_forward |
% | Select entire file | select_all |
x | Select current line, if already selected, extend to next line | extend_line_below |
X | Extend selection to line bounds (line-wise selection) | extend_to_line_bounds |
Alt-x | Shrink selection to line bounds (line-wise selection) | shrink_to_line_bounds |
J | Join lines inside selection | join_selections |
Alt-J | Join lines inside selection and select the inserted space | join_selections_space |
K | Keep selections matching the regex | keep_selections |
Alt-K | Remove selections matching the regex | remove_selections |
Ctrl-c | Comment/uncomment the selections | toggle_comments |
Alt-o, Alt-up | Expand selection to parent syntax node (TS) | expand_selection |
Alt-i, Alt-down | Shrink syntax tree object selection (TS) | shrink_selection |
Alt-p, Alt-left | Select previous sibling node in syntax tree (TS) | select_prev_sibling |
Alt-n, Alt-right | Select next sibling node in syntax tree (TS) | select_next_sibling |
Search
+Search commands all operate on the / register by default. To use a different register, use "<char>.
| Key | Description | Command |
|---|---|---|
/ | Search for regex pattern | search |
? | Search for previous pattern | rsearch |
n | Select next search match | search_next |
N | Select previous search match | search_prev |
* | Use current selection as the search pattern | search_selection |
Minor modes
+These sub-modes are accessible from normal mode and typically switch back to normal mode after a command.
+| Key | Description | Command |
|---|---|---|
v | Enter select (extend) mode | select_mode |
g | Enter goto mode | N/A |
m | Enter match mode | N/A |
: | Enter command mode | command_mode |
z | Enter view mode | N/A |
Z | Enter sticky view mode | N/A |
Ctrl-w | Enter window mode | N/A |
Space | Enter space mode | N/A |
These modes (except command mode) can be configured by +remapping keys.
+View mode
+Accessed by typing z in normal mode.
View mode is intended for scrolling and manipulating the view without changing
+the selection. The "sticky" variant of this mode (accessed by typing Z in
+normal mode) is persistent and can be exited using the escape key. This is
+useful when you're simply looking over text and not actively editing it.
| Key | Description | Command |
|---|---|---|
z, c | Vertically center the line | align_view_center |
t | Align the line to the top of the screen | align_view_top |
b | Align the line to the bottom of the screen | align_view_bottom |
m | Align the line to the middle of the screen (horizontally) | align_view_middle |
j, down | Scroll the view downwards | scroll_down |
k, up | Scroll the view upwards | scroll_up |
Ctrl-f, PageDown | Move page down | page_down |
Ctrl-b, PageUp | Move page up | page_up |
Ctrl-u | Move cursor and page half page up | page_cursor_half_up |
Ctrl-d | Move cursor and page half page down | page_cursor_half_down |
Goto mode
+Accessed by typing g in normal mode.
Jumps to various locations.
+| Key | Description | Command |
|---|---|---|
g | Go to line number <n> else start of file | goto_file_start |
e | Go to the end of the file | goto_last_line |
f | Go to files in the selections | goto_file |
h | Go to the start of the line | goto_line_start |
l | Go to the end of the line | goto_line_end |
s | Go to first non-whitespace character of the line | goto_first_nonwhitespace |
t | Go to the top of the screen | goto_window_top |
c | Go to the middle of the screen | goto_window_center |
b | Go to the bottom of the screen | goto_window_bottom |
d | Go to definition (LSP) | goto_definition |
y | Go to type definition (LSP) | goto_type_definition |
r | Go to references (LSP) | goto_reference |
i | Go to implementation (LSP) | goto_implementation |
a | Go to the last accessed/alternate file | goto_last_accessed_file |
m | Go to the last modified/alternate file | goto_last_modified_file |
n | Go to next buffer | goto_next_buffer |
p | Go to previous buffer | goto_previous_buffer |
. | Go to last modification in current file | goto_last_modification |
j | Move down textual (instead of visual) line | move_line_down |
k | Move up textual (instead of visual) line | move_line_up |
w | Show labels at each word and select the word that belongs to the entered labels | goto_word |
Match mode
+Accessed by typing m in normal mode.
See the relevant section in Usage for an explanation about +surround and textobject usage.
+| Key | Description | Command |
|---|---|---|
m | Goto matching bracket (TS) | match_brackets |
s <char> | Surround current selection with <char> | surround_add |
r <from><to> | Replace surround character <from> with <to> | surround_replace |
d <char> | Delete surround character <char> | surround_delete |
a <object> | Select around textobject | select_textobject_around |
i <object> | Select inside textobject | select_textobject_inner |
TODO: Mappings for selecting syntax nodes (a superset of [).
Window mode
+Accessed by typing Ctrl-w in normal mode.
This layer is similar to Vim keybindings as Kakoune does not support windows.
+| Key | Description | Command |
|---|---|---|
w, Ctrl-w | Switch to next window | rotate_view |
v, Ctrl-v | Vertical right split | vsplit |
s, Ctrl-s | Horizontal bottom split | hsplit |
f | Go to files in the selections in horizontal splits | goto_file |
F | Go to files in the selections in vertical splits | goto_file |
h, Ctrl-h, Left | Move to left split | jump_view_left |
j, Ctrl-j, Down | Move to split below | jump_view_down |
k, Ctrl-k, Up | Move to split above | jump_view_up |
l, Ctrl-l, Right | Move to right split | jump_view_right |
q, Ctrl-q | Close current window | wclose |
o, Ctrl-o | Only keep the current window, closing all the others | wonly |
H | Swap window to the left | swap_view_left |
J | Swap window downwards | swap_view_down |
K | Swap window upwards | swap_view_up |
L | Swap window to the right | swap_view_right |
Space mode
+Accessed by typing Space in normal mode.
This layer is a kludge of mappings, mostly pickers.
+| Key | Description | Command |
|---|---|---|
f | Open file picker | file_picker |
F | Open file picker at current working directory | file_picker_in_current_directory |
b | Open buffer picker | buffer_picker |
j | Open jumplist picker | jumplist_picker |
g | Debug (experimental) | N/A |
k | Show documentation for item under cursor in a popup (LSP) | hover |
s | Open document symbol picker (LSP) | symbol_picker |
S | Open workspace symbol picker (LSP) | workspace_symbol_picker |
d | Open document diagnostics picker (LSP) | diagnostics_picker |
D | Open workspace diagnostics picker (LSP) | workspace_diagnostics_picker |
r | Rename symbol (LSP) | rename_symbol |
a | Apply code action (LSP) | code_action |
h | Select symbol references (LSP) | select_references_to_symbol_under_cursor |
' | Open last fuzzy picker | last_picker |
w | Enter window mode | N/A |
c | Comment/uncomment selections | toggle_comments |
C | Block comment/uncomment selections | toggle_block_comments |
Alt-c | Line comment/uncomment selections | toggle_line_comments |
p | Paste system clipboard after selections | paste_clipboard_after |
P | Paste system clipboard before selections | paste_clipboard_before |
y | Yank selections to clipboard | yank_to_clipboard |
Y | Yank main selection to clipboard | yank_main_selection_to_clipboard |
R | Replace selections by clipboard contents | replace_selections_with_clipboard |
/ | Global search in workspace folder | global_search |
? | Open command palette | command_palette |
e | Reveal current file in explorer | reveal_current_file |
++💡 Global search displays results in a fuzzy picker, use
+Space + 'to bring it back up after opening a file.
Popup
+Displays documentation for item under cursor.
+| Key | Description |
|---|---|
Ctrl-u | Scroll up |
Ctrl-d | Scroll down |
Unimpaired
+These mappings are in the style of vim-unimpaired.
+| Key | Description | Command |
|---|---|---|
]d | Go to next diagnostic (LSP) | goto_next_diag |
[d | Go to previous diagnostic (LSP) | goto_prev_diag |
]D | Go to last diagnostic in document (LSP) | goto_last_diag |
[D | Go to first diagnostic in document (LSP) | goto_first_diag |
]f | Go to next function (TS) | goto_next_function |
[f | Go to previous function (TS) | goto_prev_function |
]t | Go to next type definition (TS) | goto_next_class |
[t | Go to previous type definition (TS) | goto_prev_class |
]a | Go to next argument/parameter (TS) | goto_next_parameter |
[a | Go to previous argument/parameter (TS) | goto_prev_parameter |
]c | Go to next comment (TS) | goto_next_comment |
[c | Go to previous comment (TS) | goto_prev_comment |
]T | Go to next test (TS) | goto_next_test |
[T | Go to previous test (TS) | goto_prev_test |
]p | Go to next paragraph | goto_next_paragraph |
[p | Go to previous paragraph | goto_prev_paragraph |
]g | Go to next change | goto_next_change |
[g | Go to previous change | goto_prev_change |
]G | Go to last change | goto_last_change |
[G | Go to first change | goto_first_change |
]Space | Add newline below | add_newline_below |
[Space | Add newline above | add_newline_above |
Insert mode
+Accessed by typing i in normal mode.
Insert mode bindings are minimal by default. Helix is designed to +be a modal editor, and this is reflected in the user experience and internal +mechanics. Changes to the text are only saved for undos when +escaping from insert mode to normal mode.
+++💡 New users are strongly encouraged to learn the modal editing paradigm +to get the smoothest experience.
+
| Key | Description | Command |
|---|---|---|
Escape | Switch to normal mode | normal_mode |
Ctrl-s | Commit undo checkpoint | commit_undo_checkpoint |
Ctrl-x | Autocomplete | completion |
Ctrl-r | Insert a register content | insert_register |
Ctrl-w, Alt-Backspace | Delete previous word | delete_word_backward |
Alt-d, Alt-Delete | Delete next word | delete_word_forward |
Ctrl-u | Delete to start of line | kill_to_line_start |
Ctrl-k | Delete to end of line | kill_to_line_end |
Ctrl-h, Backspace, Shift-Backspace | Delete previous char | delete_char_backward |
Ctrl-d, Delete | Delete next char | delete_char_forward |
Ctrl-j, Enter | Insert new line | insert_newline |
These keys are not recommended, but are included for new users less familiar +with modal editors.
+| Key | Description | Command |
|---|---|---|
Up | Move to previous line | move_line_up |
Down | Move to next line | move_line_down |
Left | Backward a char | move_char_left |
Right | Forward a char | move_char_right |
PageUp | Move one page up | page_up |
PageDown | Move one page down | page_down |
Home | Move to line start | goto_line_start |
End | Move to line end | goto_line_end_newline |
As you become more comfortable with modal editing, you may want to disable some
+insert mode bindings. You can do this by editing your config.toml file.
[keys.insert]
+up = "no_op"
+down = "no_op"
+left = "no_op"
+right = "no_op"
+pageup = "no_op"
+pagedown = "no_op"
+home = "no_op"
+end = "no_op"
+Select / extend mode
+Accessed by typing v in normal mode.
Select mode echoes Normal mode, but changes any movements to extend
+selections rather than replace them. Goto motions are also changed to
+extend, so that vgl, for example, extends the selection to the end of
+the line.
Search is also affected. By default, n and N will remove the current
+selection and select the next instance of the search term. Toggling this
+mode before pressing n or N makes it possible to keep the current
+selection. Toggling it on and off during your iterative searching allows
+you to selectively add search terms to your selections.
Picker
+Keys to use within picker. Remapping currently not supported.
+| Key | Description |
|---|---|
Shift-Tab, Up, Ctrl-p | Previous entry |
Tab, Down, Ctrl-n | Next entry |
PageUp, Ctrl-u | Page up |
PageDown, Ctrl-d | Page down |
Home | Go to first entry |
End | Go to last entry |
Enter | Open selected |
Alt-Enter | Open selected in the background without closing the picker |
Ctrl-s | Open horizontally |
Ctrl-v | Open vertically |
Ctrl-t | Toggle preview |
Escape, Ctrl-c | Close picker |
Prompt
+Keys to use within prompt, Remapping currently not supported.
+| Key | Description |
|---|---|
Escape, Ctrl-c | Close prompt |
Alt-b, Ctrl-Left | Backward a word |
Ctrl-b, Left | Backward a char |
Alt-f, Ctrl-Right | Forward a word |
Ctrl-f, Right | Forward a char |
Ctrl-e, End | Move prompt end |
Ctrl-a, Home | Move prompt start |
Ctrl-w, Alt-Backspace, Ctrl-Backspace | Delete previous word |
Alt-d, Alt-Delete, Ctrl-Delete | Delete next word |
Ctrl-u | Delete to start of line |
Ctrl-k | Delete to end of line |
Backspace, Ctrl-h, Shift-Backspace | Delete previous char |
Delete, Ctrl-d | Delete next char |
Ctrl-s | Insert a word under doc cursor, may be changed to Ctrl-r Ctrl-w later |
Ctrl-p, Up | Select previous history |
Ctrl-n, Down | Select next history |
Ctrl-r | Insert the content of the register selected by following input char |
Tab | Select next completion item |
BackTab | Select previous completion item |
Enter | Open selected |
File explorer
+Press ? to see keymaps. Remapping currently not supported.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/languages.html b/master/languages.html
new file mode 100644
index 00000000..15f89f67
--- /dev/null
+++ b/master/languages.html
@@ -0,0 +1,433 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Language Support
+The following languages and Language Servers are supported. To use +Language Server features, you must first install the +appropriate Language Server.
+You can check the language support in your installed helix version with hx --health.
Also see the Language Configuration docs and the Adding +Languages guide for more language configuration information.
+| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Rainbow Brackets | Default LSP |
|---|---|---|---|---|---|
| ada | ✓ | ✓ | ada_language_server, ada_language_server | ||
| agda | ✓ | ||||
| astro | ✓ | ||||
| awk | ✓ | ✓ | awk-language-server | ||
| bash | ✓ | ✓ | ✓ | ✓ | bash-language-server |
| bass | ✓ | bass | |||
| beancount | ✓ | ||||
| bibtex | ✓ | texlab | |||
| bicep | ✓ | bicep-langserver | |||
| blade | ✓ | ||||
| blueprint | ✓ | blueprint-compiler | |||
| c | ✓ | ✓ | ✓ | ✓ | clangd |
| c-sharp | ✓ | ✓ | OmniSharp | ||
| cabal | haskell-language-server-wrapper | ||||
| cairo | ✓ | ✓ | ✓ | cairo-language-server | |
| capnp | ✓ | ✓ | |||
| cel | ✓ | ||||
| clojure | ✓ | ✓ | clojure-lsp | ||
| cmake | ✓ | ✓ | ✓ | cmake-language-server | |
| comment | ✓ | ||||
| common-lisp | ✓ | ✓ | ✓ | cl-lsp | |
| cpon | ✓ | ✓ | |||
| cpp | ✓ | ✓ | ✓ | ✓ | clangd |
| crystal | ✓ | ✓ | crystalline | ||
| css | ✓ | ✓ | ✓ | vscode-css-language-server | |
| cue | ✓ | cuelsp | |||
| d | ✓ | ✓ | ✓ | serve-d | |
| dart | ✓ | ✓ | ✓ | dart | |
| dbml | ✓ | ||||
| devicetree | ✓ | ||||
| dhall | ✓ | ✓ | dhall-lsp-server | ||
| diff | ✓ | ||||
| docker-compose | ✓ | ✓ | docker-compose-langserver, yaml-language-server | ||
| dockerfile | ✓ | docker-langserver | |||
| dot | ✓ | dot-language-server | |||
| dtd | ✓ | ||||
| edoc | ✓ | ||||
| eex | ✓ | ||||
| ejs | ✓ | ||||
| elixir | ✓ | ✓ | ✓ | ✓ | elixir-ls |
| elm | ✓ | ✓ | elm-language-server | ||
| elvish | ✓ | elvish | |||
| env | ✓ | ||||
| erb | ✓ | ||||
| erlang | ✓ | ✓ | ✓ | erlang_ls | |
| esdl | ✓ | ||||
| fidl | ✓ | ||||
| fish | ✓ | ✓ | ✓ | ||
| forth | ✓ | forth-lsp | |||
| fortran | ✓ | ✓ | fortls | ||
| fsharp | ✓ | fsautocomplete | |||
| gas | ✓ | ✓ | |||
| gdscript | ✓ | ✓ | ✓ | ||
| gemini | ✓ | ||||
| git-attributes | ✓ | ||||
| git-commit | ✓ | ✓ | |||
| git-config | ✓ | ||||
| git-ignore | ✓ | ||||
| git-rebase | ✓ | ||||
| gleam | ✓ | ✓ | ✓ | gleam | |
| glimmer | ✓ | ember-language-server | |||
| glsl | ✓ | ✓ | ✓ | ||
| gn | ✓ | ||||
| go | ✓ | ✓ | ✓ | ✓ | gopls, golangci-lint-langserver |
| godot-resource | ✓ | ||||
| gomod | ✓ | gopls | |||
| gotmpl | ✓ | gopls | |||
| gowork | ✓ | gopls | |||
| graphql | ✓ | graphql-lsp | |||
| groovy | ✓ | ||||
| hare | ✓ | ||||
| haskell | ✓ | ✓ | haskell-language-server-wrapper | ||
| haskell-persistent | ✓ | ||||
| hcl | ✓ | ✓ | ✓ | terraform-ls | |
| heex | ✓ | ✓ | elixir-ls | ||
| helm | ✓ | helm_ls | |||
| hocon | ✓ | ✓ | |||
| hoon | ✓ | ||||
| hosts | ✓ | ||||
| html | ✓ | ✓ | vscode-html-language-server | ||
| hurl | ✓ | ✓ | |||
| hyprlang | ✓ | ✓ | |||
| idris | idris2-lsp | ||||
| iex | ✓ | ||||
| ini | ✓ | ||||
| janet | ✓ | ||||
| java | ✓ | ✓ | ✓ | ✓ | jdtls |
| javascript | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| jinja | ✓ | ||||
| jsdoc | ✓ | ||||
| json | ✓ | ✓ | ✓ | vscode-json-language-server | |
| json5 | ✓ | ||||
| jsonc | ✓ | ✓ | vscode-json-language-server | ||
| jsonnet | ✓ | jsonnet-language-server | |||
| jsx | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| julia | ✓ | ✓ | ✓ | julia | |
| just | ✓ | ✓ | ✓ | ||
| kdl | ✓ | ✓ | ✓ | ||
| koka | ✓ | ✓ | koka | ||
| kotlin | ✓ | kotlin-language-server | |||
| latex | ✓ | ✓ | texlab | ||
| ld | ✓ | ✓ | |||
| lean | ✓ | lean | |||
| ledger | ✓ | ||||
| llvm | ✓ | ✓ | ✓ | ||
| llvm-mir | ✓ | ✓ | ✓ | ||
| llvm-mir-yaml | ✓ | ✓ | |||
| log | ✓ | ||||
| lpf | ✓ | ||||
| lua | ✓ | ✓ | ✓ | lua-language-server | |
| make | ✓ | ✓ | |||
| markdoc | ✓ | markdoc-ls | |||
| markdown | ✓ | marksman, markdown-oxide | |||
| markdown.inline | ✓ | ||||
| matlab | ✓ | ✓ | ✓ | ||
| mermaid | ✓ | ||||
| meson | ✓ | ✓ | |||
| mint | mint | ||||
| msbuild | ✓ | ✓ | |||
| nasm | ✓ | ✓ | |||
| nickel | ✓ | ✓ | nls | ||
| nim | ✓ | ✓ | ✓ | nimlangserver | |
| nix | ✓ | ✓ | ✓ | nil | |
| nu | ✓ | nu | |||
| nunjucks | ✓ | ||||
| ocaml | ✓ | ✓ | ocamllsp | ||
| ocaml-interface | ✓ | ocamllsp | |||
| odin | ✓ | ✓ | ols | ||
| ohm | ✓ | ✓ | ✓ | ||
| opencl | ✓ | ✓ | ✓ | clangd | |
| openscad | ✓ | openscad-lsp | |||
| org | ✓ | ||||
| pascal | ✓ | ✓ | pasls | ||
| passwd | ✓ | ||||
| pem | ✓ | ||||
| perl | ✓ | ✓ | ✓ | perlnavigator | |
| php | ✓ | ✓ | ✓ | intelephense | |
| php-only | ✓ | ||||
| pkgbuild | ✓ | ✓ | ✓ | pkgbuild-language-server, bash-language-server | |
| pkl | ✓ | ✓ | |||
| po | ✓ | ✓ | |||
| pod | ✓ | ||||
| ponylang | ✓ | ✓ | ✓ | ||
| powershell | ✓ | ||||
| prisma | ✓ | prisma-language-server | |||
| prolog | swipl | ||||
| protobuf | ✓ | ✓ | ✓ | bufls, pb | |
| prql | ✓ | ||||
| purescript | ✓ | ✓ | purescript-language-server | ||
| python | ✓ | ✓ | ✓ | ✓ | pylsp |
| qml | ✓ | ✓ | qmlls | ||
| r | ✓ | R | |||
| racket | ✓ | ✓ | ✓ | racket | |
| regex | ✓ | ✓ | |||
| rego | ✓ | regols | |||
| rescript | ✓ | ✓ | rescript-language-server | ||
| rmarkdown | ✓ | ✓ | R | ||
| robot | ✓ | robotframework_ls | |||
| ron | ✓ | ✓ | |||
| rst | ✓ | ||||
| ruby | ✓ | ✓ | ✓ | ✓ | solargraph |
| rust | ✓ | ✓ | ✓ | ✓ | rust-analyzer |
| sage | ✓ | ✓ | |||
| scala | ✓ | ✓ | ✓ | metals | |
| scheme | ✓ | ✓ | ✓ | ||
| scss | ✓ | ✓ | vscode-css-language-server | ||
| slint | ✓ | ✓ | ✓ | slint-lsp | |
| smali | ✓ | ✓ | |||
| smithy | ✓ | cs | |||
| sml | ✓ | ||||
| solidity | ✓ | solc | |||
| spicedb | ✓ | ||||
| sql | ✓ | ||||
| sshclientconfig | ✓ | ||||
| starlark | ✓ | ✓ | ✓ | ||
| strace | ✓ | ||||
| supercollider | ✓ | ||||
| svelte | ✓ | ✓ | svelteserver | ||
| sway | ✓ | ✓ | ✓ | forc | |
| swift | ✓ | sourcekit-lsp | |||
| t32 | ✓ | ||||
| tablegen | ✓ | ✓ | ✓ | ||
| tact | ✓ | ✓ | ✓ | ||
| task | ✓ | ||||
| templ | ✓ | templ | |||
| tfvars | ✓ | ✓ | terraform-ls | ||
| todotxt | ✓ | ||||
| toml | ✓ | ✓ | taplo | ||
| tsq | ✓ | ✓ | |||
| tsx | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| twig | ✓ | ||||
| typescript | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| typst | ✓ | typst-lsp | |||
| ungrammar | ✓ | ||||
| unison | ✓ | ✓ | |||
| uxntal | ✓ | ||||
| v | ✓ | ✓ | ✓ | v-analyzer | |
| vala | ✓ | ✓ | vala-language-server | ||
| verilog | ✓ | ✓ | svlangserver | ||
| vhdl | ✓ | vhdl_ls | |||
| vhs | ✓ | ||||
| vue | ✓ | vue-language-server | |||
| wast | ✓ | ||||
| wat | ✓ | ||||
| webc | ✓ | ||||
| wgsl | ✓ | wgsl_analyzer | |||
| wit | ✓ | ✓ | |||
| wren | ✓ | ✓ | ✓ | ||
| xit | ✓ | ||||
| xml | ✓ | ✓ | ✓ | ||
| yaml | ✓ | ✓ | ✓ | yaml-language-server, ansible-language-server | |
| yuck | ✓ | ||||
| zig | ✓ | ✓ | ✓ | ✓ | zls |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/mark.min.js b/master/mark.min.js
new file mode 100644
index 00000000..16362318
--- /dev/null
+++ b/master/mark.min.js
@@ -0,0 +1,7 @@
+/*!***************************************************
+* mark.js v8.11.1
+* https://markjs.io/
+* Copyright (c) 2014–2018, Julian Kühnel
+* Released under the MIT license https://git.io/vwTVl
+*****************************************************/
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?module.exports=t():"function"==typeof define&&define.amd?define(t):e.Mark=t()}(this,function(){"use strict";var e="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(e){return typeof e}:function(e){return e&&"function"==typeof Symbol&&e.constructor===Symbol&&e!==Symbol.prototype?"symbol":typeof e},t=function(e,t){if(!(e instanceof t))throw new TypeError("Cannot call a class as a function")},n=function(){function e(e,t){for(var n=0;n
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+File-type detection and the
+
+
+
+
+
+
+
+
+
+
+ Languages
+Language-specific settings and settings for language servers are configured
+in languages.toml files.
languages.toml files
+There are three possible locations for a languages.toml file:
-
+
-
+
In the Helix source code, which lives in the +Helix repository. +It provides the default configurations for languages and language servers.
+
+ -
+
In your configuration directory. This overrides values +from the built-in language configuration. For example, to disable +auto-LSP-formatting in Rust:
+
+# in <config_dir>/helix/languages.toml + +[language-server.mylang-lsp] +command = "mylang-lsp" + +[[language]] +name = "rust" +auto-format = false +
+ -
+
In a
+.helixfolder in your project. Language configuration may also be +overridden local to a project by creating alanguages.tomlfile in a +.helixfolder. Its settings will be merged with the language configuration +in the configuration directory and the built-in configuration.
+
Language configuration
+Each language is configured by adding a [[language]] section to a
+languages.toml file. For example:
[[language]]
+name = "mylang"
+scope = "source.mylang"
+injection-regex = "mylang"
+file-types = ["mylang", "myl"]
+comment-tokens = "#"
+indent = { tab-width = 2, unit = " " }
+formatter = { command = "mylang-formatter" , args = ["--stdin"] }
+language-servers = [ "mylang-lsp" ]
+These configuration keys are available:
+| Key | Description |
|---|---|
name | The name of the language |
language-id | The language-id for language servers, checkout the table at TextDocumentItem for the right id |
scope | A string like source.js that identifies the language. Currently, we strive to match the scope names used by popular TextMate grammars and by the Linguist library. Usually source.<name> or text.<name> in case of markup languages |
injection-regex | regex pattern that will be tested against a language name in order to determine whether this language should be used for a potential language injection site. |
file-types | The filetypes of the language, for example ["yml", "yaml"]. See the file-type detection section below. |
shebangs | The interpreters from the shebang line, for example ["sh", "bash"] |
roots | A set of marker files to look for when trying to find the workspace root. For example Cargo.lock, yarn.lock |
auto-format | Whether to autoformat this language when saving |
diagnostic-severity | Minimal severity of diagnostic for it to be displayed. (Allowed values: Error, Warning, Info, Hint) |
comment-tokens | The tokens to use as a comment token, either a single token "//" or an array ["//", "///", "//!"] (the first token will be used for commenting). Also configurable as comment-token for backwards compatibility |
block-comment-tokens | The start and end tokens for a multiline comment either an array or single table of { start = "/*", end = "*/"}. The first set of tokens will be used for commenting, any pairs in the array can be uncommented |
indent | The indent to use. Has sub keys unit (the text inserted into the document when indenting; usually set to N spaces or "\t" for tabs) and tab-width (the number of spaces rendered for a tab) |
language-servers | The Language Servers used for this language. See below for more information in the section Configuring Language Servers for a language |
grammar | The tree-sitter grammar to use (defaults to the value of name) |
formatter | The formatter for the language, it will take precedence over the lsp when defined. The formatter must be able to take the original file as input from stdin and write the formatted file to stdout |
soft-wrap | editor.softwrap |
text-width | Maximum line length. Used for the :reflow command and soft-wrapping if soft-wrap.wrap-at-text-width is set, defaults to editor.text-width |
workspace-lsp-roots | Directories relative to the workspace root that are treated as LSP roots. Should only be set in .helix/config.toml. Overwrites the setting of the same name in config.toml if set. |
persistent-diagnostic-sources | An array of LSP diagnostic sources assumed unchanged when the language server resends the same set of diagnostics. Helix can track the position for these diagnostics internally instead. Useful for diagnostics that are recomputed on save. |
rulers | Overrides the editor.rulers config key for the language. |
rainbow-brackets | Overrides the editor.rainbow-brackets config key for the language. |
File-type detection and the file-types key
+Helix determines which language configuration to use based on the file-types key
+from the above section. file-types is a list of strings or tables, for
+example:
file-types = ["toml", { glob = "Makefile" }, { glob = ".git/config" }, { glob = ".github/workflows/*.yaml" } ]
+When determining a language configuration to use, Helix searches the file-types +with the following priorities:
+-
+
- Glob: values in
globtables are checked against the full path of the given +file. Globs are standard Unix-style path globs (e.g. the kind you use in Shell) +and can be used to match paths for a specific prefix, suffix, directory, etc. +In the above example, the{ glob = "Makefile" }config would match files +with the nameMakefile, the{ glob = ".git/config" }config would match +configfiles in.gitdirectories, and the{ glob = ".github/workflows/*.yaml" }+config would match anyyamlfiles in.github/workflowdirectories. Note +that globs should always use the Unix path separator/even on Windows systems; +the matcher will automatically take the machine-specific separators into account. +If the glob isn't an absolute path or doesn't already start with a glob prefix, +*/will automatically be added to ensure it matches for any subdirectory.
+ - Extension: if there are no glob matches, any
file-typesstring that matches +the file extension of a given file wins. In the example above, the"toml"+config matches files likeCargo.tomlorlanguages.toml.
+
Language Server configuration
+Language servers are configured separately in the table language-server in the same file as the languages languages.toml
For example:
+[language-server.mylang-lsp]
+command = "mylang-lsp"
+args = ["--stdio"]
+config = { provideFormatter = true }
+environment = { "ENV1" = "value1", "ENV2" = "value2" }
+
+[language-server.efm-lsp-prettier]
+command = "efm-langserver"
+
+[language-server.efm-lsp-prettier.config]
+documentFormatting = true
+languages = { typescript = [ { formatCommand ="prettier --stdin-filepath ${INPUT}", formatStdin = true } ] }
+These are the available options for a language server.
+| Key | Description |
|---|---|
command | The name or path of the language server binary to execute. Binaries must be in $PATH |
args | A list of arguments to pass to the language server binary |
config | LSP initialization options |
timeout | The maximum time a request to the language server may take, in seconds. Defaults to 20 |
environment | Any environment variables that will be used when starting the language server { "KEY1" = "Value1", "KEY2" = "Value2" } |
required-root-patterns | A list of glob patterns to look for in the working directory. The language server is started if at least one of them is found. |
A format sub-table within config can be used to pass extra formatting options to
+Document Formatting Requests.
+For example, with typescript:
[language-server.typescript-language-server]
+# pass format options according to https://github.com/typescript-language-server/typescript-language-server#workspacedidchangeconfiguration omitting the "[language].format." prefix.
+config = { format = { "semicolons" = "insert", "insertSpaceBeforeFunctionParenthesis" = true } }
+Configuring Language Servers for a language
+The language-servers attribute in a language tells helix which language servers are used for this language.
They have to be defined in the [language-server] table as described in the previous section.
Different languages can use the same language server instance, e.g. typescript-language-server is used for javascript, jsx, tsx and typescript by default.
In case multiple language servers are specified in the language-servers attribute of a language,
+it's often useful to only enable/disable certain language-server features for these language servers.
As an example, efm-lsp-prettier of the previous example is used only with a formatting command prettier,
+so everything else should be handled by the typescript-language-server (which is configured by default).
+The language configuration for typescript could look like this:
[[language]]
+name = "typescript"
+language-servers = [ { name = "efm-lsp-prettier", only-features = [ "format" ] }, "typescript-language-server" ]
+or equivalent:
+[[language]]
+name = "typescript"
+language-servers = [ { name = "typescript-language-server", except-features = [ "format" ] }, "efm-lsp-prettier" ]
+Each requested LSP feature is prioritized in the order of the language-servers array.
+For example, the first goto-definition supported language server (in this case typescript-language-server) will be taken for the relevant LSP request (command goto_definition).
+The features diagnostics, code-action, completion, document-symbols and workspace-symbols are an exception to that rule, as they are working for all language servers at the same time and are merged together, if enabled for the language.
+If no except-features or only-features is given, all features for the language server are enabled.
+If a language server itself doesn't support a feature, the next language server array entry will be tried (and so on).
The list of supported features is:
+-
+
format
+goto-definition
+goto-declaration
+goto-type-definition
+goto-reference
+goto-implementation
+signature-help
+hover
+document-highlight
+completion
+code-action
+workspace-command
+document-symbols
+workspace-symbols
+diagnostics
+rename-symbol
+inlay-hints
+
Tree-sitter grammar configuration
+The source for a language's tree-sitter grammar is specified in a [[grammar]]
+section in languages.toml. For example:
[[grammar]]
+name = "mylang"
+source = { git = "https://github.com/example/mylang", rev = "a250c4582510ff34767ec3b7dcdd3c24e8c8aa68" }
+Grammar configuration takes these keys:
+| Key | Description |
|---|---|
name | The name of the tree-sitter grammar |
source | The method of fetching the grammar - a table with a schema defined below |
Where source is a table with either these keys when using a grammar from a
+git repository:
| Key | Description |
|---|---|
git | A git remote URL from which the grammar should be cloned |
rev | The revision (commit hash or tag) which should be fetched |
subpath | A path within the grammar directory which should be built. Some grammar repositories host multiple grammars (for example tree-sitter-typescript and tree-sitter-ocaml) in subdirectories. This key is used to point hx --grammar build to the correct path for compilation. When omitted, the root of repository is used |
Choosing grammars
+You may use a top-level use-grammars key to control which grammars are
+fetched and built when using hx --grammar fetch and hx --grammar build.
# Note: this key must come **before** the [[language]] and [[grammar]] sections
+use-grammars = { only = [ "rust", "c", "cpp" ] }
+# or
+use-grammars = { except = [ "yaml", "json" ] }
+When omitted, all grammars are fetched and built.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/remapping.html b/master/remapping.html
new file mode 100644
index 00000000..aaacb71d
--- /dev/null
+++ b/master/remapping.html
@@ -0,0 +1,315 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+File-type detection and the
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Helix
+Docs for bleeding edge master can be found at +https://docs.helix-editor.com/master.
+See the usage section for a quick overview of the editor, keymap +section for all available keybindings and the configuration section +for defining custom keybindings, setting themes, etc. +For everything else (e.g., how to install supported language servers), see the Helix Wiki.
+Refer the FAQ for common questions.
+Installing Helix
+ +-
+
- Pre-built binaries +
- Linux, macOS, Windows and OpenBSD packaging status +
- Linux
+
-
+
- Ubuntu +
- Fedora/RHEL +
- Arch Linux extra +
- NixOS +
- Flatpak +
- Snap +
- AppImage +
+ - macOS + + +
- Windows
+
-
+
- Winget +
- Scoop +
- Chocolatey +
- MSYS2 +
+ - Building from source + + +
To install Helix, follow the instructions specific to your operating system. +Note that:
+-
+
-
+
To get the latest nightly version of Helix, you need to +build from source.
+
+ -
+
To take full advantage of Helix, install the language servers for your +preferred programming languages. See the +wiki +for instructions.
+
+
Pre-built binaries
+Download pre-built binaries from the
+GitHub Releases page. Add the binary to your system's $PATH to use it from the command
+line.
Linux, macOS, Windows and OpenBSD packaging status
+
Linux
+The following third party repositories are available:
+Ubuntu
+Add the PPA for Helix:
sudo add-apt-repository ppa:maveonair/helix-editor
+sudo apt update
+sudo apt install helix
+Fedora/RHEL
+sudo dnf install helix
+Arch Linux extra
+Releases are available in the extra repository:
sudo pacman -S helix
+++💡 When installed from the
+extrarepository, run Helix withhelixinstead ofhx.For example:
++helix --health +to check health
+
Additionally, a helix-git package is available +in the AUR, which builds the master branch.
+NixOS
+Helix is available in nixpkgs through the helix attribute,
+the unstable channel usually carries the latest release.
Helix is also available as a flake in the project
+root. Use nix develop to spin up a reproducible development shell. Outputs are
+cached for each push to master using Cachix. The
+flake is configured to automatically make use of this cache assuming the user
+accepts the new settings on first use.
If you are using a version of Nix without flakes enabled,
+install Cachix CLI and use
+cachix use helix to configure Nix to use cached outputs when possible.
Flatpak
+Helix is available on Flathub:
+flatpak install flathub com.helix_editor.Helix
+flatpak run com.helix_editor.Helix
+Snap
+Helix is available on Snapcraft and can be installed with:
+snap install --classic helix
+This will install Helix as both /snap/bin/helix and /snap/bin/hx, so make sure /snap/bin is in your PATH.
AppImage
+Install Helix using the Linux AppImage format. +Download the official Helix AppImage from the latest releases page.
+chmod +x helix-*.AppImage # change permission for executable mode
+./helix-*.AppImage # run helix
+macOS
+Homebrew Core
+brew install helix
+MacPorts
+port install helix
+Windows
+Install on Windows using Winget, Scoop, Chocolatey +or MSYS2.
+Winget
+Windows Package Manager winget command-line tool is by default available on Windows 11 and modern versions of Windows 10 as a part of the App Installer. +You can get App Installer from the Microsoft Store. If it's already installed, make sure it is updated with the latest version.
+winget install Helix.Helix
+Scoop
+scoop install helix
+Chocolatey
+choco install helix
+MSYS2
+For 64-bit Windows 8.1 or above:
+pacman -S mingw-w64-ucrt-x86_64-helix
+Building from source
+Requirements:
+Clone the Helix GitHub repository into a directory of your choice. The
+examples in this documentation assume installation into either ~/src/ on
+Linux and macOS, or %userprofile%\src\ on Windows.
-
+
- The Rust toolchain +
- The Git version control system +
- A C++14 compatible compiler to build the tree-sitter grammars, for example GCC or Clang +
If you are using the musl-libc standard library instead of glibc the following environment variable must be set during the build to ensure tree-sitter grammars can be loaded correctly:
RUSTFLAGS="-C target-feature=-crt-static"
+-
+
-
+
Clone the repository:
+
+git clone https://github.com/helix-editor/helix +cd helix +
+ -
+
Compile from source:
+
+cargo install --path helix-term --locked +This command will create the
+hxexecutable and construct the tree-sitter +grammars in the localruntimefolder.
+
++💡 If you do not want to fetch or build grammars, set an environment variable
+HELIX_DISABLE_AUTO_GRAMMAR_BUILD
++💡 Tree-sitter grammars can be fetched and compiled if not pre-packaged. Fetch +grammars with
+hx --grammar fetchand compile them with +hx --grammar build. This will install them in +theruntimedirectory within the user's helix config directory (more +details below).
Configuring Helix's runtime files
+Linux and macOS
+The runtime directory is one below the Helix source, so either export a
+HELIX_RUNTIME environment variable to point to that directory and add it to
+your ~/.bashrc or equivalent:
export HELIX_RUNTIME=~/src/helix/runtime
+Or, create a symbolic link:
+ln -Ts $PWD/runtime ~/.config/helix/runtime
+If the above command fails to create a symbolic link because the file exists either move ~/.config/helix/runtime to a new location or delete it, then run the symlink command above again.
Windows
+Either set the HELIX_RUNTIME environment variable to point to the runtime files using the Windows setting (search for
+Edit environment variables for your account) or use the setx command in
+Cmd:
setx HELIX_RUNTIME "%userprofile%\source\repos\helix\runtime"
+++💡
+%userprofile%resolves to your user directory like +C:\Users\Your-Name\for example.
Or, create a symlink in %appdata%\helix\ that links to the source code directory:
| Method | Command |
|---|---|
| PowerShell | New-Item -ItemType Junction -Target "runtime" -Path "$Env:AppData\helix\runtime" |
| Cmd | cd %appdata%\helix mklink /D runtime "%userprofile%\src\helix\runtime" |
++💡 On Windows, creating a symbolic link may require running PowerShell or +Cmd as an administrator.
+
Multiple runtime directories
+When Helix finds multiple runtime directories it will search through them for files in the +following order:
+-
+
runtime/sibling directory to$CARGO_MANIFEST_DIRdirectory (this is intended for +developing and testing helix only).
+runtime/subdirectory of OS-dependent helix user config directory.
+$HELIX_RUNTIME
+- Distribution-specific fallback directory (set at compile time—not run time—
+with the
HELIX_DEFAULT_RUNTIMEenvironment variable)
+ runtime/subdirectory of path to Helix executable.
+
This order also sets the priority for selecting which file will be used if multiple runtime +directories have files with the same name.
+Note to packagers
+If you are making a package of Helix for end users, to provide a good out of
+the box experience, you should set the HELIX_DEFAULT_RUNTIME environment
+variable at build time (before invoking cargo build) to a directory which
+will store the final runtime files after installation. For example, say you want
+to package the runtime into /usr/lib/helix/runtime. The rough steps a build
+script could follow are:
-
+
export HELIX_DEFAULT_RUNTIME=/usr/lib/helix/runtime
+cargo build --profile opt --locked --path helix-term
+cp -r runtime $BUILD_DIR/usr/lib/helix/
+cp target/opt/hx $BUILD_DIR/usr/bin/hx
+
This way the resulting hx binary will always look for its runtime directory in
+/usr/lib/helix/runtime if the user has no custom runtime in ~/.config/helix
+or HELIX_RUNTIME.
Validating the installation
+To make sure everything is set up as expected you should run the Helix health +check:
+hx --health
+For more information on the health check results refer to +Health check.
+Configure the desktop shortcut
+If your desktop environment supports the
+XDG desktop menu
+you can configure Helix to show up in the application menu by copying the
+provided .desktop and icon files to their correct folders:
cp contrib/Helix.desktop ~/.local/share/applications
+cp contrib/helix.png ~/.icons # or ~/.local/share/icons
+To use another terminal than the system default, you can modify the .desktop
+file. For example, to use kitty:
sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
+sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
+Using Helix
+ +-
+
- Registers + + +
- Surround +
- Selecting and manipulating text with textobjects +
- Navigating using tree-sitter textobjects +
- Moving the selection with syntax-aware motions +
For a full interactive introduction to Helix, refer to the
+tutor which
+can be accessed via the command hx --tutor or :tutor.
++💡 Currently, not all functionality is fully documented, please refer to the +key mappings list.
+
Registers
+In Helix, registers are storage locations for text and other data, such as the
+result of a search. Registers can be used to cut, copy, and paste text, similar
+to the clipboard in other text editors. Usage is similar to Vim, with " being
+used to select a register.
User-defined registers
+Helix allows you to create your own named registers for storing text, for +example:
+-
+
"ay- Yank the current selection to registera.
+"op- Paste the text in registeroafter the selection.
+
If a register is selected before invoking a change or delete command, the selection will be stored in the register and the action will be carried out:
+-
+
"hc- Store the selection in registerhand then change it (delete and enter insert mode).
+"md- Store the selection in registermand delete it.
+
Default registers
+Commands that use registers, like yank (y), use a default register if none is specified.
+These registers are used as defaults:
| Register character | Contains |
|---|---|
/ | Last search |
: | Last executed command |
" | Last yanked text |
@ | Last recorded macro |
Special registers
+Some registers have special behavior when read from and written to.
+| Register character | When read | When written |
|---|---|---|
_ | No values are returned | All values are discarded |
# | Selection indices (first selection is 1, second is 2, etc.) | This register is not writable |
. | Contents of the current selections | This register is not writable |
% | Name of the current file | This register is not writable |
+ | Reads from the system clipboard | Joins and yanks to the system clipboard |
* | Reads from the primary clipboard | Joins and yanks to the primary clipboard |
When yanking multiple selections to the clipboard registers, the selections +are joined with newlines. Pasting from these registers will paste multiple +selections if the clipboard was last yanked to by the Helix session. Otherwise +the clipboard contents are pasted as one selection.
+Surround
+Helix includes built-in functionality similar to vim-surround. +The keymappings have been inspired from vim-sandwich:
+
| Key Sequence | Action |
|---|---|
ms<char> (after selecting text) | Add surround characters to selection |
mr<char_to_replace><new_char> | Replace the closest surround characters |
md<char_to_delete> | Delete the closest surround characters |
You can use counts to act on outer pairs.
+Surround can also act on multiple selections. For example, to change every occurrence of (use) to [use]:
-
+
%to select the whole file
+sto split the selections on a search term
+- Input
useand hit Enter
+ mr([to replace the parentheses with square brackets
+
Multiple characters are currently not supported, but planned for future release.
+Selecting and manipulating text with textobjects
+In Helix, textobjects are a way to select, manipulate and operate on a piece of +text in a structured way. They allow you to refer to blocks of text based on +their structure or purpose, such as a word, sentence, paragraph, or even a +function or block of code.
+
+
-
+
ma- Select around the object (vain Vim,<alt-a>in Kakoune)
+mi- Select inside the object (viin Vim,<alt-i>in Kakoune)
+
Key after mi or ma | Textobject selected |
|---|---|
w | Word |
W | WORD |
p | Paragraph |
(, [, ', etc. | Specified surround pairs |
m | The closest surround pair |
f | Function |
t | Type (or Class) |
a | Argument/parameter |
c | Comment |
T | Test |
g | Change |
++💡
+f,t, etc. need a tree-sitter grammar active for the current +document and a special tree-sitter query file to work properly. Only +some grammars currently have the query file implemented. +Contributions are welcome!
Navigating using tree-sitter textobjects
+Navigating between functions, classes, parameters, and other elements is
+possible using tree-sitter and textobject queries. For
+example to move to the next function use ]f, to move to previous
+type use [t, and so on.
For the full reference see the unimpaired section of the key bind +documentation.
+++💡 This feature relies on tree-sitter textobjects +and requires the corresponding query file to work properly.
+
Moving the selection with syntax-aware motions
+Alt-p, Alt-o, Alt-i, and Alt-n (or Alt and arrow keys) allow you to move the
+selection according to its location in the syntax tree. For example, many languages have the
+following syntax for function calls:
func(arg1, arg2, arg3);
+A function call might be parsed by tree-sitter into a tree like the following.
+(call
+ function: (identifier) ; func
+ arguments:
+ (arguments ; (arg1, arg2, arg3)
+ (identifier) ; arg1
+ (identifier) ; arg2
+ (identifier))) ; arg3
+Use :tree-sitter-subtree to view the syntax tree of the primary selection. In
+a more intuitive tree format:
┌────┐
+ │call│
+ ┌─────┴────┴─────┐
+ │ │
+┌─────▼────┐ ┌────▼────┐
+│identifier│ │arguments│
+│ "func" │ ┌────┴───┬─────┴───┐
+└──────────┘ │ │ │
+ │ │ │
+ ┌─────────▼┐ ┌────▼─────┐ ┌▼─────────┐
+ │identifier│ │identifier│ │identifier│
+ │ "arg1" │ │ "arg2" │ │ "arg3" │
+ └──────────┘ └──────────┘ └──────────┘
+If you have a selection that wraps arg1 (see the tree above), and you use
+Alt-n, it will select the next sibling in the syntax tree: arg2.
// before
+func([arg1], arg2, arg3)
+// after
+func(arg1, [arg2], arg3);
+Similarly, Alt-o will expand the selection to the parent node, in this case, the
+arguments node.
func[(arg1, arg2, arg3)];
+There is also some nuanced behavior that prevents you from getting stuck on a
+node with no sibling. When using Alt-p with a selection on arg1, the previous
+child node will be selected. In the event that arg1 does not have a previous
+sibling, the selection will move up the syntax tree and select the previous
+element. As a result, using Alt-p with a selection on arg1 will move the
+selection to the "func" identifier.
Keymap
+-
+
- Normal mode
+
-
+
- Movement +
- Changes
+
-
+
- Shell +
+ - Selection manipulation +
- Search +
- Minor modes
+
-
+
- View mode +
- Goto mode +
- Match mode +
- Window mode +
- Space mode
+
-
+
- Comment mode +
- Popup +
+ - Unimpaired +
+
+ - Insert mode +
- Select / extend mode +
- Picker +
- Prompt +
++💡 Mappings marked (LSP) require an active language server for the file.
+
++💡 Mappings marked (TS) require a tree-sitter grammar for the file type.
+
Normal mode
+Normal mode is the default mode when you launch helix. You can return to it from other modes by pressing the Escape key.
Movement
+++NOTE: Unlike Vim,
+f,F,tandTare not confined to the current line.
| Key | Description | Command |
|---|---|---|
h, Left | Move left | move_char_left |
j, Down | Move down | move_visual_line_down |
k, Up | Move up | move_visual_line_up |
l, Right | Move right | move_char_right |
w | Move next word start | move_next_word_start |
b | Move previous word start | move_prev_word_start |
e | Move next word end | move_next_word_end |
W | Move next WORD start | move_next_long_word_start |
B | Move previous WORD start | move_prev_long_word_start |
E | Move next WORD end | move_next_long_word_end |
t | Find 'till next char | find_till_char |
f | Find next char | find_next_char |
T | Find 'till previous char | till_prev_char |
F | Find previous char | find_prev_char |
G | Go to line number <n> | goto_line |
Alt-. | Repeat last motion (f, t, m, [ or ]) | repeat_last_motion |
Home | Move to the start of the line | goto_line_start |
End | Move to the end of the line | goto_line_end |
Ctrl-b, PageUp | Move page up | page_up |
Ctrl-f, PageDown | Move page down | page_down |
Ctrl-u | Move cursor and page half page up | page_cursor_half_up |
Ctrl-d | Move cursor and page half page down | page_cursor_half_down |
Ctrl-i | Jump forward on the jumplist | jump_forward |
Ctrl-o | Jump backward on the jumplist | jump_backward |
Ctrl-s | Save the current selection to the jumplist | save_selection |
Changes
+| Key | Description | Command |
|---|---|---|
r | Replace with a character | replace |
R | Replace with yanked text | replace_with_yanked |
~ | Switch case of the selected text | switch_case |
` | Set the selected text to lower case | switch_to_lowercase |
Alt-` | Set the selected text to upper case | switch_to_uppercase |
i | Insert before selection | insert_mode |
a | Insert after selection (append) | append_mode |
I | Insert at the start of the line | insert_at_line_start |
A | Insert at the end of the line | insert_at_line_end |
\ | Insert digraphs | insert_digraph |
o | Open new line below selection | open_below |
O | Open new line above selection | open_above |
. | Repeat last insert | N/A |
u | Undo change | undo |
U | Redo change | redo |
Alt-u | Move backward in history | earlier |
Alt-U | Move forward in history | later |
y | Yank selection | yank |
p | Paste after selection | paste_after |
P | Paste before selection | paste_before |
" <reg> | Select a register to yank to or paste from | select_register |
> | Indent selection | indent |
< | Unindent selection | unindent |
= | Format selection (currently nonfunctional/disabled) (LSP) | format_selections |
d | Delete selection | delete_selection |
Alt-d | Delete selection, without yanking | delete_selection_noyank |
c | Change selection (delete and enter insert mode) | change_selection |
Alt-c | Change selection (delete and enter insert mode, without yanking) | change_selection_noyank |
Ctrl-a | Increment object (number) under cursor | increment |
Ctrl-x | Decrement object (number) under cursor | decrement |
Q | Start/stop macro recording to the selected register (experimental) | record_macro |
q | Play back a recorded macro from the selected register (experimental) | replay_macro |
Shell
+| Key | Description | Command |
|---|---|---|
| | Pipe each selection through shell command, replacing with output | shell_pipe |
Alt-| | Pipe each selection into shell command, ignoring output | shell_pipe_to |
! | Run shell command, inserting output before each selection | shell_insert_output |
Alt-! | Run shell command, appending output after each selection | shell_append_output |
$ | Pipe each selection into shell command, keep selections where command returned 0 | shell_keep_pipe |
Selection manipulation
+| Key | Description | Command |
|---|---|---|
s | Select all regex matches inside selections | select_regex |
S | Split selection into sub selections on regex matches | split_selection |
Alt-s | Split selection on newlines | split_selection_on_newline |
Alt-minus | Merge selections | merge_selections |
Alt-_ | Merge consecutive selections | merge_consecutive_selections |
& | Align selection in columns | align_selections |
_ | Trim whitespace from the selection | trim_selections |
; | Collapse selection onto a single cursor | collapse_selection |
Alt-; | Flip selection cursor and anchor | flip_selections |
Alt-: | Ensures the selection is in forward direction | ensure_selections_forward |
, | Keep only the primary selection | keep_primary_selection |
Alt-, | Remove the primary selection | remove_primary_selection |
C | Copy selection onto the next line (Add cursor below) | copy_selection_on_next_line |
Alt-C | Copy selection onto the previous line (Add cursor above) | copy_selection_on_prev_line |
( | Rotate main selection backward | rotate_selections_backward |
) | Rotate main selection forward | rotate_selections_forward |
Alt-( | Rotate selection contents backward | rotate_selection_contents_backward |
Alt-) | Rotate selection contents forward | rotate_selection_contents_forward |
% | Select entire file | select_all |
x | Select current line, if already selected, extend to next line | extend_line_below |
X | Extend selection to line bounds (line-wise selection) | extend_to_line_bounds |
Alt-x | Shrink selection to line bounds (line-wise selection) | shrink_to_line_bounds |
J | Join lines inside selection | join_selections |
Alt-J | Join lines inside selection and select the inserted space | join_selections_space |
K | Keep selections matching the regex | keep_selections |
Alt-K | Remove selections matching the regex | remove_selections |
Ctrl-c | Comment/uncomment the selections | toggle_comments |
Alt-o, Alt-up | Expand selection to parent syntax node (TS) | expand_selection |
Alt-i, Alt-down | Shrink syntax tree object selection (TS) | shrink_selection |
Alt-p, Alt-left | Select previous sibling node in syntax tree (TS) | select_prev_sibling |
Alt-n, Alt-right | Select next sibling node in syntax tree (TS) | select_next_sibling |
Search
+Search commands all operate on the / register by default. To use a different register, use "<char>.
| Key | Description | Command |
|---|---|---|
/ | Search for regex pattern | search |
? | Search for previous pattern | rsearch |
n | Select next search match | search_next |
N | Select previous search match | search_prev |
* | Use current selection as the search pattern | search_selection |
Minor modes
+These sub-modes are accessible from normal mode and typically switch back to normal mode after a command.
+| Key | Description | Command |
|---|---|---|
v | Enter select (extend) mode | select_mode |
g | Enter goto mode | N/A |
m | Enter match mode | N/A |
: | Enter command mode | command_mode |
z | Enter view mode | N/A |
Z | Enter sticky view mode | N/A |
Ctrl-w | Enter window mode | N/A |
Space | Enter space mode | N/A |
These modes (except command mode) can be configured by +remapping keys.
+View mode
+Accessed by typing z in normal mode.
View mode is intended for scrolling and manipulating the view without changing
+the selection. The "sticky" variant of this mode (accessed by typing Z in
+normal mode) is persistent and can be exited using the escape key. This is
+useful when you're simply looking over text and not actively editing it.
| Key | Description | Command |
|---|---|---|
z, c | Vertically center the line | align_view_center |
t | Align the line to the top of the screen | align_view_top |
b | Align the line to the bottom of the screen | align_view_bottom |
m | Align the line to the middle of the screen (horizontally) | align_view_middle |
j, down | Scroll the view downwards | scroll_down |
k, up | Scroll the view upwards | scroll_up |
Ctrl-f, PageDown | Move page down | page_down |
Ctrl-b, PageUp | Move page up | page_up |
Ctrl-u | Move cursor and page half page up | page_cursor_half_up |
Ctrl-d | Move cursor and page half page down | page_cursor_half_down |
Goto mode
+Accessed by typing g in normal mode.
Jumps to various locations.
+| Key | Description | Command |
|---|---|---|
g | Go to line number <n> else start of file | goto_file_start |
e | Go to the end of the file | goto_last_line |
f | Go to files in the selections | goto_file |
h | Go to the start of the line | goto_line_start |
l | Go to the end of the line | goto_line_end |
s | Go to first non-whitespace character of the line | goto_first_nonwhitespace |
t | Go to the top of the screen | goto_window_top |
c | Go to the middle of the screen | goto_window_center |
b | Go to the bottom of the screen | goto_window_bottom |
d | Go to definition (LSP) | goto_definition |
y | Go to type definition (LSP) | goto_type_definition |
r | Go to references (LSP) | goto_reference |
i | Go to implementation (LSP) | goto_implementation |
a | Go to the last accessed/alternate file | goto_last_accessed_file |
m | Go to the last modified/alternate file | goto_last_modified_file |
n | Go to next buffer | goto_next_buffer |
p | Go to previous buffer | goto_previous_buffer |
. | Go to last modification in current file | goto_last_modification |
j | Move down textual (instead of visual) line | move_line_down |
k | Move up textual (instead of visual) line | move_line_up |
w | Show labels at each word and select the word that belongs to the entered labels | goto_word |
Match mode
+Accessed by typing m in normal mode.
See the relevant section in Usage for an explanation about +surround and textobject usage.
+| Key | Description | Command |
|---|---|---|
m | Goto matching bracket (TS) | match_brackets |
s <char> | Surround current selection with <char> | surround_add |
r <from><to> | Replace surround character <from> with <to> | surround_replace |
d <char> | Delete surround character <char> | surround_delete |
a <object> | Select around textobject | select_textobject_around |
i <object> | Select inside textobject | select_textobject_inner |
TODO: Mappings for selecting syntax nodes (a superset of [).
Window mode
+Accessed by typing Ctrl-w in normal mode.
This layer is similar to Vim keybindings as Kakoune does not support windows.
+| Key | Description | Command |
|---|---|---|
w, Ctrl-w | Switch to next window | rotate_view |
v, Ctrl-v | Vertical right split | vsplit |
s, Ctrl-s | Horizontal bottom split | hsplit |
f | Go to files in the selections in horizontal splits | goto_file |
F | Go to files in the selections in vertical splits | goto_file |
h, Ctrl-h, Left | Move to left split | jump_view_left |
j, Ctrl-j, Down | Move to split below | jump_view_down |
k, Ctrl-k, Up | Move to split above | jump_view_up |
l, Ctrl-l, Right | Move to right split | jump_view_right |
q, Ctrl-q | Close current window | wclose |
o, Ctrl-o | Only keep the current window, closing all the others | wonly |
H | Swap window to the left | swap_view_left |
J | Swap window downwards | swap_view_down |
K | Swap window upwards | swap_view_up |
L | Swap window to the right | swap_view_right |
Space mode
+Accessed by typing Space in normal mode.
This layer is a kludge of mappings, mostly pickers.
+| Key | Description | Command |
|---|---|---|
f | Open file picker | file_picker |
F | Open file picker at current working directory | file_picker_in_current_directory |
b | Open buffer picker | buffer_picker |
j | Open jumplist picker | jumplist_picker |
g | Debug (experimental) | N/A |
k | Show documentation for item under cursor in a popup (LSP) | hover |
s | Open document symbol picker (LSP) | symbol_picker |
S | Open workspace symbol picker (LSP) | workspace_symbol_picker |
d | Open document diagnostics picker (LSP) | diagnostics_picker |
D | Open workspace diagnostics picker (LSP) | workspace_diagnostics_picker |
r | Rename symbol (LSP) | rename_symbol |
a | Apply code action (LSP) | code_action |
h | Select symbol references (LSP) | select_references_to_symbol_under_cursor |
' | Open last fuzzy picker | last_picker |
w | Enter window mode | N/A |
c | Comment/uncomment selections | toggle_comments |
C | Block comment/uncomment selections | toggle_block_comments |
Alt-c | Line comment/uncomment selections | toggle_line_comments |
p | Paste system clipboard after selections | paste_clipboard_after |
P | Paste system clipboard before selections | paste_clipboard_before |
y | Yank selections to clipboard | yank_to_clipboard |
Y | Yank main selection to clipboard | yank_main_selection_to_clipboard |
R | Replace selections by clipboard contents | replace_selections_with_clipboard |
/ | Global search in workspace folder | global_search |
? | Open command palette | command_palette |
e | Reveal current file in explorer | reveal_current_file |
++💡 Global search displays results in a fuzzy picker, use
+Space + 'to bring it back up after opening a file.
Popup
+Displays documentation for item under cursor.
+| Key | Description |
|---|---|
Ctrl-u | Scroll up |
Ctrl-d | Scroll down |
Unimpaired
+These mappings are in the style of vim-unimpaired.
+| Key | Description | Command |
|---|---|---|
]d | Go to next diagnostic (LSP) | goto_next_diag |
[d | Go to previous diagnostic (LSP) | goto_prev_diag |
]D | Go to last diagnostic in document (LSP) | goto_last_diag |
[D | Go to first diagnostic in document (LSP) | goto_first_diag |
]f | Go to next function (TS) | goto_next_function |
[f | Go to previous function (TS) | goto_prev_function |
]t | Go to next type definition (TS) | goto_next_class |
[t | Go to previous type definition (TS) | goto_prev_class |
]a | Go to next argument/parameter (TS) | goto_next_parameter |
[a | Go to previous argument/parameter (TS) | goto_prev_parameter |
]c | Go to next comment (TS) | goto_next_comment |
[c | Go to previous comment (TS) | goto_prev_comment |
]T | Go to next test (TS) | goto_next_test |
[T | Go to previous test (TS) | goto_prev_test |
]p | Go to next paragraph | goto_next_paragraph |
[p | Go to previous paragraph | goto_prev_paragraph |
]g | Go to next change | goto_next_change |
[g | Go to previous change | goto_prev_change |
]G | Go to last change | goto_last_change |
[G | Go to first change | goto_first_change |
]Space | Add newline below | add_newline_below |
[Space | Add newline above | add_newline_above |
Insert mode
+Accessed by typing i in normal mode.
Insert mode bindings are minimal by default. Helix is designed to +be a modal editor, and this is reflected in the user experience and internal +mechanics. Changes to the text are only saved for undos when +escaping from insert mode to normal mode.
+++💡 New users are strongly encouraged to learn the modal editing paradigm +to get the smoothest experience.
+
| Key | Description | Command |
|---|---|---|
Escape | Switch to normal mode | normal_mode |
Ctrl-s | Commit undo checkpoint | commit_undo_checkpoint |
Ctrl-x | Autocomplete | completion |
Ctrl-r | Insert a register content | insert_register |
Ctrl-w, Alt-Backspace | Delete previous word | delete_word_backward |
Alt-d, Alt-Delete | Delete next word | delete_word_forward |
Ctrl-u | Delete to start of line | kill_to_line_start |
Ctrl-k | Delete to end of line | kill_to_line_end |
Ctrl-h, Backspace, Shift-Backspace | Delete previous char | delete_char_backward |
Ctrl-d, Delete | Delete next char | delete_char_forward |
Ctrl-j, Enter | Insert new line | insert_newline |
These keys are not recommended, but are included for new users less familiar +with modal editors.
+| Key | Description | Command |
|---|---|---|
Up | Move to previous line | move_line_up |
Down | Move to next line | move_line_down |
Left | Backward a char | move_char_left |
Right | Forward a char | move_char_right |
PageUp | Move one page up | page_up |
PageDown | Move one page down | page_down |
Home | Move to line start | goto_line_start |
End | Move to line end | goto_line_end_newline |
As you become more comfortable with modal editing, you may want to disable some
+insert mode bindings. You can do this by editing your config.toml file.
[keys.insert]
+up = "no_op"
+down = "no_op"
+left = "no_op"
+right = "no_op"
+pageup = "no_op"
+pagedown = "no_op"
+home = "no_op"
+end = "no_op"
+Select / extend mode
+Accessed by typing v in normal mode.
Select mode echoes Normal mode, but changes any movements to extend
+selections rather than replace them. Goto motions are also changed to
+extend, so that vgl, for example, extends the selection to the end of
+the line.
Search is also affected. By default, n and N will remove the current
+selection and select the next instance of the search term. Toggling this
+mode before pressing n or N makes it possible to keep the current
+selection. Toggling it on and off during your iterative searching allows
+you to selectively add search terms to your selections.
Picker
+Keys to use within picker. Remapping currently not supported.
+| Key | Description |
|---|---|
Shift-Tab, Up, Ctrl-p | Previous entry |
Tab, Down, Ctrl-n | Next entry |
PageUp, Ctrl-u | Page up |
PageDown, Ctrl-d | Page down |
Home | Go to first entry |
End | Go to last entry |
Enter | Open selected |
Alt-Enter | Open selected in the background without closing the picker |
Ctrl-s | Open horizontally |
Ctrl-v | Open vertically |
Ctrl-t | Toggle preview |
Escape, Ctrl-c | Close picker |
Prompt
+Keys to use within prompt, Remapping currently not supported.
+| Key | Description |
|---|---|
Escape, Ctrl-c | Close prompt |
Alt-b, Ctrl-Left | Backward a word |
Ctrl-b, Left | Backward a char |
Alt-f, Ctrl-Right | Forward a word |
Ctrl-f, Right | Forward a char |
Ctrl-e, End | Move prompt end |
Ctrl-a, Home | Move prompt start |
Ctrl-w, Alt-Backspace, Ctrl-Backspace | Delete previous word |
Alt-d, Alt-Delete, Ctrl-Delete | Delete next word |
Ctrl-u | Delete to start of line |
Ctrl-k | Delete to end of line |
Backspace, Ctrl-h, Shift-Backspace | Delete previous char |
Delete, Ctrl-d | Delete next char |
Ctrl-s | Insert a word under doc cursor, may be changed to Ctrl-r Ctrl-w later |
Ctrl-p, Up | Select previous history |
Ctrl-n, Down | Select next history |
Ctrl-r | Insert the content of the register selected by following input char |
Tab | Select next completion item |
BackTab | Select previous completion item |
Enter | Open selected |
File explorer
+Press ? to see keymaps. Remapping currently not supported.
Commands
+Command mode can be activated by pressing :. The built-in commands are:
| Name | Description |
|---|---|
:quit, :q | Close the current view. |
:quit!, :q! | Force close the current view, ignoring unsaved changes. |
:open, :o | Open a file from disk into the current view. |
:buffer-close, :bc, :bclose | Close the current buffer. |
:buffer-close!, :bc!, :bclose! | Close the current buffer forcefully, ignoring unsaved changes. |
:buffer-close-others, :bco, :bcloseother | Close all buffers but the currently focused one. |
:buffer-close-others!, :bco!, :bcloseother! | Force close all buffers but the currently focused one. |
:buffer-close-all, :bca, :bcloseall | Close all buffers without quitting. |
:buffer-close-all!, :bca!, :bcloseall! | Force close all buffers ignoring unsaved changes without quitting. |
:buffer-next, :bn, :bnext | Goto next buffer. |
:buffer-previous, :bp, :bprev | Goto previous buffer. |
:write, :w | Write changes to disk. Accepts an optional path (:write some/path.txt) |
:write!, :w! | Force write changes to disk creating necessary subdirectories. Accepts an optional path (:write! some/path.txt) |
:write-buffer-close, :wbc | Write changes to disk and closes the buffer. Accepts an optional path (:write-buffer-close some/path.txt) |
:write-buffer-close!, :wbc! | Force write changes to disk creating necessary subdirectories and closes the buffer. Accepts an optional path (:write-buffer-close! some/path.txt) |
:new, :n | Create a new scratch buffer. |
:format, :fmt | Format the file using the LSP formatter. |
:indent-style | Set the indentation style for editing. ('t' for tabs or 1-16 for number of spaces.) |
:line-ending | Set the document's default line ending. Options: crlf, lf. |
:earlier, :ear | Jump back to an earlier point in edit history. Accepts a number of steps or a time span. |
:later, :lat | Jump to a later point in edit history. Accepts a number of steps or a time span. |
:write-quit, :wq, :x | Write changes to disk and close the current view. Accepts an optional path (:wq some/path.txt) |
:write-quit!, :wq!, :x! | Write changes to disk and close the current view forcefully. Accepts an optional path (:wq! some/path.txt) |
:write-all, :wa | Write changes from all buffers to disk. |
:write-all!, :wa! | Forcefully write changes from all buffers to disk creating necessary subdirectories. |
:write-quit-all, :wqa, :xa | Write changes from all buffers to disk and close all views. |
:write-quit-all!, :wqa!, :xa! | Write changes from all buffers to disk and close all views forcefully (ignoring unsaved changes). |
:quit-all, :qa | Close all views. |
:quit-all!, :qa! | Force close all views ignoring unsaved changes. |
:cquit, :cq | Quit with exit code (default 1). Accepts an optional integer exit code (:cq 2). |
:cquit!, :cq! | Force quit with exit code (default 1) ignoring unsaved changes. Accepts an optional integer exit code (:cq! 2). |
:theme | Change the editor theme (show current theme if no name specified). |
:yank-join | Yank joined selections. A separator can be provided as first argument. Default value is newline. |
:clipboard-yank | Yank main selection into system clipboard. |
:clipboard-yank-join | Yank joined selections into system clipboard. A separator can be provided as first argument. Default value is newline. |
:primary-clipboard-yank | Yank main selection into system primary clipboard. |
:primary-clipboard-yank-join | Yank joined selections into system primary clipboard. A separator can be provided as first argument. Default value is newline. |
:clipboard-paste-after | Paste system clipboard after selections. |
:clipboard-paste-before | Paste system clipboard before selections. |
:clipboard-paste-replace | Replace selections with content of system clipboard. |
:primary-clipboard-paste-after | Paste primary clipboard after selections. |
:primary-clipboard-paste-before | Paste primary clipboard before selections. |
:primary-clipboard-paste-replace | Replace selections with content of system primary clipboard. |
:show-clipboard-provider | Show clipboard provider name in status bar. |
:change-current-directory, :cd | Change the current working directory. |
:show-directory, :pwd | Show the current working directory. |
:encoding | Set encoding. Based on https://encoding.spec.whatwg.org. |
:character-info, :char | Get info about the character under the primary cursor. |
:reload, :rl | Discard changes and reload from the source file. |
:reload-all, :rla | Discard changes and reload all documents from the source files. |
:update, :u | Write changes only if the file has been modified. |
:lsp-workspace-command | Open workspace command picker |
:lsp-restart | Restarts the language servers used by the current doc |
:lsp-stop | Stops the language servers that are used by the current doc |
:tree-sitter-scopes | Display tree sitter scopes, primarily for theming and development. |
:tree-sitter-highlight-name | Display name of tree-sitter highlight scope under the cursor. |
:debug-start, :dbg | Start a debug session from a given template with given parameters. |
:debug-remote, :dbg-tcp | Connect to a debug adapter by TCP address and start a debugging session from a given template with given parameters. |
:debug-eval | Evaluate expression in current debug context. |
:vsplit, :vs | Open the file in a vertical split. |
:vsplit-new, :vnew | Open a scratch buffer in a vertical split. |
:hsplit, :hs, :sp | Open the file in a horizontal split. |
:hsplit-new, :hnew | Open a scratch buffer in a horizontal split. |
:tutor | Open the tutorial. |
:goto, :g | Goto line number. |
:set-language, :lang | Set the language of current buffer (show current language if no value specified). |
:set-option, :set | Set a config option at runtime. For example to disable smart case search, use :set search.smart-case false. |
:toggle-option, :toggle | Toggle a boolean config option at runtime. For example to toggle smart case search, use :toggle search.smart-case. |
:get-option, :get | Get the current value of a config option. |
:sort | Sort ranges in selection. |
:rsort | Sort ranges in selection in reverse order. |
:reflow | Hard-wrap the current selection of lines to a given width. |
:tree-sitter-subtree, :ts-subtree | Display tree sitter subtree under cursor, primarily for debugging queries. |
:config-reload | Refresh user config. |
:config-open | Open the user config.toml file. |
:config-open-workspace | Open the workspace config.toml file. |
:log-open | Open the helix log file. |
:insert-output | Run shell command, inserting output before each selection. |
:append-output | Run shell command, appending output after each selection. |
:pipe | Pipe each selection to the shell command. |
:pipe-to | Pipe each selection to the shell command, ignoring output. |
:run-shell-command, :sh | Run a shell command |
:reset-diff-change, :diffget, :diffg | Reset the diff change at the cursor position. |
:clear-register | Clear given register. If no argument is provided, clear all registers. |
:redraw | Clear and re-render the whole UI |
:move | Move the current buffer and its corresponding file to a different path |
:yank-diagnostic | Yank diagnostic(s) under primary cursor to register, or clipboard by default |
Language Support
+The following languages and Language Servers are supported. To use +Language Server features, you must first install the +appropriate Language Server.
+You can check the language support in your installed helix version with hx --health.
Also see the Language Configuration docs and the Adding +Languages guide for more language configuration information.
+| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Rainbow Brackets | Default LSP |
|---|---|---|---|---|---|
| ada | ✓ | ✓ | ada_language_server, ada_language_server | ||
| agda | ✓ | ||||
| astro | ✓ | ||||
| awk | ✓ | ✓ | awk-language-server | ||
| bash | ✓ | ✓ | ✓ | ✓ | bash-language-server |
| bass | ✓ | bass | |||
| beancount | ✓ | ||||
| bibtex | ✓ | texlab | |||
| bicep | ✓ | bicep-langserver | |||
| blade | ✓ | ||||
| blueprint | ✓ | blueprint-compiler | |||
| c | ✓ | ✓ | ✓ | ✓ | clangd |
| c-sharp | ✓ | ✓ | OmniSharp | ||
| cabal | haskell-language-server-wrapper | ||||
| cairo | ✓ | ✓ | ✓ | cairo-language-server | |
| capnp | ✓ | ✓ | |||
| cel | ✓ | ||||
| clojure | ✓ | ✓ | clojure-lsp | ||
| cmake | ✓ | ✓ | ✓ | cmake-language-server | |
| comment | ✓ | ||||
| common-lisp | ✓ | ✓ | ✓ | cl-lsp | |
| cpon | ✓ | ✓ | |||
| cpp | ✓ | ✓ | ✓ | ✓ | clangd |
| crystal | ✓ | ✓ | crystalline | ||
| css | ✓ | ✓ | ✓ | vscode-css-language-server | |
| cue | ✓ | cuelsp | |||
| d | ✓ | ✓ | ✓ | serve-d | |
| dart | ✓ | ✓ | ✓ | dart | |
| dbml | ✓ | ||||
| devicetree | ✓ | ||||
| dhall | ✓ | ✓ | dhall-lsp-server | ||
| diff | ✓ | ||||
| docker-compose | ✓ | ✓ | docker-compose-langserver, yaml-language-server | ||
| dockerfile | ✓ | docker-langserver | |||
| dot | ✓ | dot-language-server | |||
| dtd | ✓ | ||||
| edoc | ✓ | ||||
| eex | ✓ | ||||
| ejs | ✓ | ||||
| elixir | ✓ | ✓ | ✓ | ✓ | elixir-ls |
| elm | ✓ | ✓ | elm-language-server | ||
| elvish | ✓ | elvish | |||
| env | ✓ | ||||
| erb | ✓ | ||||
| erlang | ✓ | ✓ | ✓ | erlang_ls | |
| esdl | ✓ | ||||
| fidl | ✓ | ||||
| fish | ✓ | ✓ | ✓ | ||
| forth | ✓ | forth-lsp | |||
| fortran | ✓ | ✓ | fortls | ||
| fsharp | ✓ | fsautocomplete | |||
| gas | ✓ | ✓ | |||
| gdscript | ✓ | ✓ | ✓ | ||
| gemini | ✓ | ||||
| git-attributes | ✓ | ||||
| git-commit | ✓ | ✓ | |||
| git-config | ✓ | ||||
| git-ignore | ✓ | ||||
| git-rebase | ✓ | ||||
| gleam | ✓ | ✓ | ✓ | gleam | |
| glimmer | ✓ | ember-language-server | |||
| glsl | ✓ | ✓ | ✓ | ||
| gn | ✓ | ||||
| go | ✓ | ✓ | ✓ | ✓ | gopls, golangci-lint-langserver |
| godot-resource | ✓ | ||||
| gomod | ✓ | gopls | |||
| gotmpl | ✓ | gopls | |||
| gowork | ✓ | gopls | |||
| graphql | ✓ | graphql-lsp | |||
| groovy | ✓ | ||||
| hare | ✓ | ||||
| haskell | ✓ | ✓ | haskell-language-server-wrapper | ||
| haskell-persistent | ✓ | ||||
| hcl | ✓ | ✓ | ✓ | terraform-ls | |
| heex | ✓ | ✓ | elixir-ls | ||
| helm | ✓ | helm_ls | |||
| hocon | ✓ | ✓ | |||
| hoon | ✓ | ||||
| hosts | ✓ | ||||
| html | ✓ | ✓ | vscode-html-language-server | ||
| hurl | ✓ | ✓ | |||
| hyprlang | ✓ | ✓ | |||
| idris | idris2-lsp | ||||
| iex | ✓ | ||||
| ini | ✓ | ||||
| janet | ✓ | ||||
| java | ✓ | ✓ | ✓ | ✓ | jdtls |
| javascript | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| jinja | ✓ | ||||
| jsdoc | ✓ | ||||
| json | ✓ | ✓ | ✓ | vscode-json-language-server | |
| json5 | ✓ | ||||
| jsonc | ✓ | ✓ | vscode-json-language-server | ||
| jsonnet | ✓ | jsonnet-language-server | |||
| jsx | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| julia | ✓ | ✓ | ✓ | julia | |
| just | ✓ | ✓ | ✓ | ||
| kdl | ✓ | ✓ | ✓ | ||
| koka | ✓ | ✓ | koka | ||
| kotlin | ✓ | kotlin-language-server | |||
| latex | ✓ | ✓ | texlab | ||
| ld | ✓ | ✓ | |||
| lean | ✓ | lean | |||
| ledger | ✓ | ||||
| llvm | ✓ | ✓ | ✓ | ||
| llvm-mir | ✓ | ✓ | ✓ | ||
| llvm-mir-yaml | ✓ | ✓ | |||
| log | ✓ | ||||
| lpf | ✓ | ||||
| lua | ✓ | ✓ | ✓ | lua-language-server | |
| make | ✓ | ✓ | |||
| markdoc | ✓ | markdoc-ls | |||
| markdown | ✓ | marksman, markdown-oxide | |||
| markdown.inline | ✓ | ||||
| matlab | ✓ | ✓ | ✓ | ||
| mermaid | ✓ | ||||
| meson | ✓ | ✓ | |||
| mint | mint | ||||
| msbuild | ✓ | ✓ | |||
| nasm | ✓ | ✓ | |||
| nickel | ✓ | ✓ | nls | ||
| nim | ✓ | ✓ | ✓ | nimlangserver | |
| nix | ✓ | ✓ | ✓ | nil | |
| nu | ✓ | nu | |||
| nunjucks | ✓ | ||||
| ocaml | ✓ | ✓ | ocamllsp | ||
| ocaml-interface | ✓ | ocamllsp | |||
| odin | ✓ | ✓ | ols | ||
| ohm | ✓ | ✓ | ✓ | ||
| opencl | ✓ | ✓ | ✓ | clangd | |
| openscad | ✓ | openscad-lsp | |||
| org | ✓ | ||||
| pascal | ✓ | ✓ | pasls | ||
| passwd | ✓ | ||||
| pem | ✓ | ||||
| perl | ✓ | ✓ | ✓ | perlnavigator | |
| php | ✓ | ✓ | ✓ | intelephense | |
| php-only | ✓ | ||||
| pkgbuild | ✓ | ✓ | ✓ | pkgbuild-language-server, bash-language-server | |
| pkl | ✓ | ✓ | |||
| po | ✓ | ✓ | |||
| pod | ✓ | ||||
| ponylang | ✓ | ✓ | ✓ | ||
| powershell | ✓ | ||||
| prisma | ✓ | prisma-language-server | |||
| prolog | swipl | ||||
| protobuf | ✓ | ✓ | ✓ | bufls, pb | |
| prql | ✓ | ||||
| purescript | ✓ | ✓ | purescript-language-server | ||
| python | ✓ | ✓ | ✓ | ✓ | pylsp |
| qml | ✓ | ✓ | qmlls | ||
| r | ✓ | R | |||
| racket | ✓ | ✓ | ✓ | racket | |
| regex | ✓ | ✓ | |||
| rego | ✓ | regols | |||
| rescript | ✓ | ✓ | rescript-language-server | ||
| rmarkdown | ✓ | ✓ | R | ||
| robot | ✓ | robotframework_ls | |||
| ron | ✓ | ✓ | |||
| rst | ✓ | ||||
| ruby | ✓ | ✓ | ✓ | ✓ | solargraph |
| rust | ✓ | ✓ | ✓ | ✓ | rust-analyzer |
| sage | ✓ | ✓ | |||
| scala | ✓ | ✓ | ✓ | metals | |
| scheme | ✓ | ✓ | ✓ | ||
| scss | ✓ | ✓ | vscode-css-language-server | ||
| slint | ✓ | ✓ | ✓ | slint-lsp | |
| smali | ✓ | ✓ | |||
| smithy | ✓ | cs | |||
| sml | ✓ | ||||
| solidity | ✓ | solc | |||
| spicedb | ✓ | ||||
| sql | ✓ | ||||
| sshclientconfig | ✓ | ||||
| starlark | ✓ | ✓ | ✓ | ||
| strace | ✓ | ||||
| supercollider | ✓ | ||||
| svelte | ✓ | ✓ | svelteserver | ||
| sway | ✓ | ✓ | ✓ | forc | |
| swift | ✓ | sourcekit-lsp | |||
| t32 | ✓ | ||||
| tablegen | ✓ | ✓ | ✓ | ||
| tact | ✓ | ✓ | ✓ | ||
| task | ✓ | ||||
| templ | ✓ | templ | |||
| tfvars | ✓ | ✓ | terraform-ls | ||
| todotxt | ✓ | ||||
| toml | ✓ | ✓ | taplo | ||
| tsq | ✓ | ✓ | |||
| tsx | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| twig | ✓ | ||||
| typescript | ✓ | ✓ | ✓ | ✓ | typescript-language-server |
| typst | ✓ | typst-lsp | |||
| ungrammar | ✓ | ||||
| unison | ✓ | ✓ | |||
| uxntal | ✓ | ||||
| v | ✓ | ✓ | ✓ | v-analyzer | |
| vala | ✓ | ✓ | vala-language-server | ||
| verilog | ✓ | ✓ | svlangserver | ||
| vhdl | ✓ | vhdl_ls | |||
| vhs | ✓ | ||||
| vue | ✓ | vue-language-server | |||
| wast | ✓ | ||||
| wat | ✓ | ||||
| webc | ✓ | ||||
| wgsl | ✓ | wgsl_analyzer | |||
| wit | ✓ | ✓ | |||
| wren | ✓ | ✓ | ✓ | ||
| xit | ✓ | ||||
| xml | ✓ | ✓ | ✓ | ||
| yaml | ✓ | ✓ | ✓ | yaml-language-server, ansible-language-server | |
| yuck | ✓ | ||||
| zig | ✓ | ✓ | ✓ | ✓ | zls |
Migrating from Vim
+Helix's editing model is strongly inspired from Vim and Kakoune, and a notable
+difference from Vim (and the most striking similarity to Kakoune) is that Helix
+follows the selection → action model. This means that whatever you are
+going to act on (a word, a paragraph, a line, etc.) is selected first and the
+action itself (delete, change, yank, etc.) comes second. A cursor is simply a
+single width selection.
See also Kakoune's Migrating from Vim and Helix's Migrating from Vim.
+++TODO: Mention textobjects, surround, registers
+
Configuration
+To override global configuration parameters, create a config.toml file located in your config directory:
-
+
- Linux and Mac:
~/.config/helix/config.toml
+ - Windows:
%AppData%\helix\config.toml
+
++💡 You can easily open the config file by typing
+:config-openwithin Helix normal mode.
Example config:
+theme = "onedark"
+
+[editor]
+line-number = "relative"
+mouse = false
+
+[editor.cursor-shape]
+insert = "bar"
+normal = "block"
+select = "underline"
+
+[editor.file-picker]
+hidden = false
+You can use a custom configuration file by specifying it with the -c or
+--config command line argument, for example hx -c path/to/custom-config.toml.
+Additionally, you can reload the configuration file by sending the USR1
+signal to the Helix process on Unix operating systems, such as by using the command pkill -USR1 hx.
Finally, you can have a config.toml local to a project by putting it under a .helix directory in your repository.
+Its settings will be merged with the configuration directory config.toml and the built-in configuration.
Editor
+[editor] Section
+| Key | Description | Default |
|---|---|---|
scrolloff | Number of lines of padding around the edge of the screen when scrolling | 5 |
mouse | Enable mouse mode | true |
middle-click-paste | Middle click paste support | true |
scroll-lines | Number of lines to scroll per scroll wheel step | 3 |
shell | Shell to use when running external commands | Unix: ["sh", "-c"]Windows: ["cmd", "/C"] |
line-number | Line number display: absolute simply shows each line's number, while relative shows the distance from the current line. When unfocused or in insert mode, relative will still show absolute line numbers | absolute |
cursorline | Highlight all lines with a cursor | false |
cursorcolumn | Highlight all columns with a cursor | false |
gutters | Gutters to display: Available are diagnostics and diff and line-numbers and spacer, note that diagnostics also includes other features like breakpoints, 1-width padding will be inserted if gutters is non-empty | ["diagnostics", "spacer", "line-numbers", "spacer", "diff"] |
auto-completion | Enable automatic pop up of auto-completion | true |
auto-format | Enable automatic formatting on save | true |
auto-save | Enable automatic saving on the focus moving away from Helix. Requires focus event support from your terminal | false |
idle-timeout | Time in milliseconds since last keypress before idle timers trigger. | 250 |
completion-timeout | Time in milliseconds after typing a word character before completions are shown, set to 5 for instant. | 250 |
preview-completion-insert | Whether to apply completion item instantly when selected | true |
completion-trigger-len | The min-length of word under cursor to trigger autocompletion | 2 |
completion-replace | Set to true to make completions always replace the entire word and not just the part before the cursor | false |
auto-info | Whether to display info boxes | true |
true-color | Set to true to override automatic detection of terminal truecolor support in the event of a false negative | false |
undercurl | Set to true to override automatic detection of terminal undercurl support in the event of a false negative | false |
rulers | List of column positions at which to display the rulers. Can be overridden by language specific rulers in languages.toml file | [] |
bufferline | Renders a line at the top of the editor displaying open buffers. Can be always, never or multiple (only shown if more than one buffer is in use) | never |
color-modes | Whether to color the mode indicator with different colors depending on the mode itself | false |
text-width | Maximum line length. Used for the :reflow command and soft-wrapping if soft-wrap.wrap-at-text-width is set | 80 |
workspace-lsp-roots | Directories relative to the workspace root that are treated as LSP roots. Should only be set in .helix/config.toml | [] |
default-line-ending | The line ending to use for new documents. Can be native, lf, crlf, ff, cr or nel. native uses the platform's native line ending (crlf on Windows, otherwise lf). | native |
insert-final-newline | Whether to automatically insert a trailing line-ending on write if missing | true |
popup-border | Draw border around popup, menu, all, or none | none |
indent-heuristic | How the indentation for a newly inserted line is computed: simple just copies the indentation level from the previous line, tree-sitter computes the indentation based on the syntax tree and hybrid combines both approaches. If the chosen heuristic is not available, a different one will be used as a fallback (the fallback order being hybrid -> tree-sitter -> simple). | hybrid |
jump-label-alphabet | The characters that are used to generate two character jump labels. Characters at the start of the alphabet are used first. | "abcdefghijklmnopqrstuvwxyz" |
initial-mode | The initial mode for newly opened editors. | "normal" |
rainbow-brackets | Whether to render rainbow colors for matching brackets. Requires tree-sitter rainbows.scm queries for the language. | false |
[editor.statusline] Section
+Allows configuring the statusline at the bottom of the editor.
+The configuration distinguishes between three areas of the status line:
+[ ... ... LEFT ... ... | ... ... ... CENTER ... ... ... | ... ... RIGHT ... ... ]
Statusline elements can be defined as follows:
+[editor.statusline]
+left = ["mode", "spinner"]
+center = ["file-name"]
+right = ["diagnostics", "selections", "position", "file-encoding", "file-line-ending", "file-type"]
+separator = "│"
+mode.normal = "NORMAL"
+mode.insert = "INSERT"
+mode.select = "SELECT"
+The [editor.statusline] key takes the following sub-keys:
| Key | Description | Default |
|---|---|---|
left | A list of elements aligned to the left of the statusline | ["mode", "spinner", "file-name", "read-only-indicator", "file-modification-indicator"] |
center | A list of elements aligned to the middle of the statusline | [] |
right | A list of elements aligned to the right of the statusline | ["diagnostics", "selections", "register", "position", "file-encoding"] |
separator | The character used to separate elements in the statusline | "│" |
mode.normal | The text shown in the mode element for normal mode | "NOR" |
mode.insert | The text shown in the mode element for insert mode | "INS" |
mode.select | The text shown in the mode element for select mode | "SEL" |
The following statusline elements can be configured:
+| Key | Description |
|---|---|
mode | The current editor mode (mode.normal/mode.insert/mode.select) |
spinner | A progress spinner indicating LSP activity |
file-name | The path/name of the opened file |
file-absolute-path | The absolute path/name of the opened file |
file-base-name | The basename of the opened file |
file-modification-indicator | The indicator to show whether the file is modified (a [+] appears when there are unsaved changes) |
file-encoding | The encoding of the opened file if it differs from UTF-8 |
file-line-ending | The file line endings (CRLF or LF) |
read-only-indicator | An indicator that shows [readonly] when a file cannot be written |
total-line-numbers | The total line numbers of the opened file |
file-type | The type of the opened file |
diagnostics | The number of warnings and/or errors |
workspace-diagnostics | The number of warnings and/or errors on workspace |
selections | The number of active selections |
primary-selection-length | The number of characters currently in primary selection |
position | The cursor position |
position-percentage | The cursor position as a percentage of the total number of lines |
separator | The string defined in editor.statusline.separator (defaults to "│") |
spacer | Inserts a space between elements (multiple/contiguous spacers may be specified) |
version-control | The current branch name or detached commit hash of the opened workspace |
register | The current selected register |
[editor.lsp] Section
+| Key | Description | Default |
|---|---|---|
enable | Enables LSP integration. Setting to false will completely disable language servers regardless of language settings. | true |
display-messages | Display LSP progress messages below statusline1 | false |
auto-signature-help | Enable automatic popup of signature help (parameter hints) | true |
display-inlay-hints | Display inlay hints2 | false |
display-signature-help-docs | Display docs under signature help popup | true |
snippets | Enables snippet completions. Requires a server restart (:lsp-restart) to take effect after :config-reload/:set. | true |
goto-reference-include-declaration | Include declaration in the goto references popup. | true |
1
+
+By default, a progress spinner is shown in the statusline beside the file path.
+2
+
+You may also have to activate them in the LSP config for them to appear, not just in Helix. Inlay hints in Helix are still being improved on and may be a little bit laggy/janky under some circumstances. Please report any bugs you see so we can fix them!
+[editor.cursor-shape] Section
+Defines the shape of cursor in each mode.
+Valid values for these options are block, bar, underline, or hidden.
++💡 Due to limitations of the terminal environment, only the primary cursor can +change shape.
+
| Key | Description | Default |
|---|---|---|
normal | Cursor shape in normal mode | block |
insert | Cursor shape in insert mode | block |
select | Cursor shape in select mode | block |
[editor.file-picker] Section
+Set options for file picker and global search. Ignoring a file means it is +not visible in the Helix file picker and global search.
+All git related options are only enabled in a git repository.
+| Key | Description | Default |
|---|---|---|
hidden | Enables ignoring hidden files | true |
follow-symlinks | Follow symlinks instead of ignoring them | true |
deduplicate-links | Ignore symlinks that point at files already shown in the picker | true |
parents | Enables reading ignore files from parent directories | true |
ignore | Enables reading .ignore files | true |
git-ignore | Enables reading .gitignore files | true |
git-global | Enables reading global .gitignore, whose path is specified in git's config: core.excludesfile option | true |
git-exclude | Enables reading .git/info/exclude files | true |
max-depth | Set with an integer value for maximum depth to recurse | Unset by default |
Ignore files can be placed locally as .ignore or put in your home directory as ~/.ignore. They support the usual ignore and negative ignore (unignore) rules used in .gitignore files.
Additionally, you can use Helix-specific ignore files by creating a local .helix/ignore file in the current workspace or a global ignore file located in your Helix config directory:
-
+
- Linux and Mac:
~/.config/helix/ignore
+ - Windows:
%AppData%\helix\ignore
+
Example:
+# unignore in file picker and global search
+!.github/
+!.gitignore
+!.gitattributes
+[editor.auto-pairs] Section
+Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a +simple boolean value, or a specific mapping of pairs of single characters.
+To disable auto-pairs altogether, set auto-pairs to false:
[editor]
+auto-pairs = false # defaults to `true`
+The default pairs are (){}[]''""``, but these can be customized by
+setting auto-pairs to a TOML table:
[editor.auto-pairs]
+'(' = ')'
+'{' = '}'
+'[' = ']'
+'"' = '"'
+'`' = '`'
+'<' = '>'
+Additionally, this setting can be used in a language config. Unless
+the editor setting is false, this will override the editor config in
+documents with this language.
Example languages.toml that adds <> and removes ''
[[language]]
+name = "rust"
+
+[language.auto-pairs]
+'(' = ')'
+'{' = '}'
+'[' = ']'
+'"' = '"'
+'`' = '`'
+'<' = '>'
+[editor.search] Section
+Search specific options.
+| Key | Description | Default |
|---|---|---|
smart-case | Enable smart case regex searching (case-insensitive unless pattern contains upper case characters) | true |
wrap-around | Whether the search should wrap after depleting the matches | true |
[editor.whitespace] Section
+Options for rendering whitespace with visible characters. Use :set whitespace.render all to temporarily enable visible whitespace.
| Key | Description | Default |
|---|---|---|
render | Whether to render whitespace. May either be all or none, or a table with sub-keys space, nbsp, nnbsp, tab, and newline | none |
characters | Literal characters to use when rendering whitespace. Sub-keys may be any of tab, space, nbsp, nnbsp, newline or tabpad | See example below |
Example
+[editor.whitespace]
+render = "all"
+# or control each character
+[editor.whitespace.render]
+space = "all"
+tab = "all"
+nbsp = "none"
+nnbsp = "none"
+newline = "none"
+
+[editor.whitespace.characters]
+space = "·"
+nbsp = "⍽"
+nnbsp = "␣"
+tab = "→"
+newline = "⏎"
+tabpad = "·" # Tabs will look like "→···" (depending on tab width)
+[editor.indent-guides] Section
+Options for rendering vertical indent guides.
+| Key | Description | Default |
|---|---|---|
render | Whether to render indent guides | false |
character | Literal character to use for rendering the indent guide | │ |
skip-levels | Number of indent levels to skip | 0 |
rainbow-option | Enum to set rainbow indentations. Options: normal, dim and none. | none |
Example:
+[editor.indent-guides]
+render = true
+character = "╎" # Some characters that work well: "▏", "┆", "┊", "⸽"
+skip-levels = 1
+rainbow-option = "normal"
+[editor.gutters] Section
+For simplicity, editor.gutters accepts an array of gutter types, which will
+use default settings for all gutter components.
[editor]
+gutters = ["diff", "diagnostics", "line-numbers", "spacer"]
+To customize the behavior of gutters, the [editor.gutters] section must
+be used. This section contains top level settings, as well as settings for
+specific gutter components as subsections.
| Key | Description | Default |
|---|---|---|
layout | A vector of gutters to display | ["diagnostics", "spacer", "line-numbers", "spacer", "diff"] |
Example:
+[editor.gutters]
+layout = ["diff", "diagnostics", "line-numbers", "spacer"]
+[editor.gutters.line-numbers] Section
+Options for the line number gutter
+| Key | Description | Default |
|---|---|---|
min-width | The minimum number of characters to use | 3 |
Example:
+[editor.gutters.line-numbers]
+min-width = 1
+[editor.gutters.diagnostics] Section
+Currently unused
+[editor.gutters.diff] Section
+The diff gutter option displays colored bars indicating whether a git diff represents that a line was added, removed or changed.
+These colors are controlled by the theme attributes diff.plus, diff.minus and diff.delta.
Other diff providers will eventually be supported by a future plugin system.
+There are currently no options for this section.
+[editor.gutters.spacer] Section
+Currently unused
+[editor.soft-wrap] Section
+Options for soft wrapping lines that exceed the view width:
+| Key | Description | Default |
|---|---|---|
enable | Whether soft wrapping is enabled. | false |
max-wrap | Maximum free space left at the end of the line. | 20 |
max-indent-retain | Maximum indentation to carry over when soft wrapping a line. | 40 |
wrap-indicator | Text inserted before soft wrapped lines, highlighted with ui.virtual.wrap | ↪ |
wrap-at-text-width | Soft wrap at text-width instead of using the full viewport size. | false |
Example:
+[editor.soft-wrap]
+enable = true
+max-wrap = 25 # increase value to reduce forced mid-word wrapping
+max-indent-retain = 0
+wrap-indicator = "" # set wrap-indicator to "" to hide it
+[editor.smart-tab] Section
+Options for navigating and editing using tab key.
+| Key | Description | Default |
|---|---|---|
enable | If set to true, then when the cursor is in a position with non-whitespace to its left, instead of inserting a tab, it will run move_parent_node_end. If there is only whitespace to the left, then it inserts a tab as normal. With the default bindings, to explicitly insert a tab character, press Shift-tab. | true |
supersede-menu | Normally, when a menu is on screen, such as when auto complete is triggered, the tab key is bound to cycling through the items. This means when menus are on screen, one cannot use the tab key to trigger the smart-tab command. If this option is set to true, the smart-tab command always takes precedence, which means one cannot use the tab key to cycle through menu items. One of the other bindings must be used instead, such as arrow keys or C-n/C-p. | false |
Due to lack of support for S-tab in some terminals, the default keybindings don't fully embrace smart-tab editing experience. If you enjoy smart-tab navigation and a terminal that supports the Enhanced Keyboard protocol, consider setting extra keybindings:
+[keys.normal]
+tab = "move_parent_node_end"
+S-tab = "move_parent_node_start"
+
+[keys.insert]
+S-tab = "move_parent_node_start"
+
+[keys.select]
+tab = "extend_parent_node_end"
+S-tab = "extend_parent_node_start"
+[editor.explorer] Section
+Sets explorer side width and style.
+| Key | Description | Default |
|---|---|---|
column-width | explorer side width | 30 |
position | explorer widget position, left or right | left |
[editor.digraphs] Section
+By default, special characters can be input using the insert_digraphs command, bound to \ in normal mode.
+Custom digraphs can be added to the editor.digraphs section of the config.
[editor.digraphs]
+ka = "か"
+ku = { symbols = "く", description = "The japanese character Ku" }
+shrug = "¯\\_(ツ)_/¯"
+Themes
+To use a theme add theme = "<name>" to the top of your config.toml file, or select it during runtime using :theme <name>.
Creating a theme
+Create a file with the name of your theme as the file name (i.e mytheme.toml) and place it in your themes directory (i.e ~/.config/helix/themes or %AppData%\helix\themes on Windows). The directory might have to be created beforehand.
++💡 The names "default" and "base16_default" are reserved for built-in themes +and cannot be overridden by user-defined themes.
+
Overview
+Each line in the theme file is specified as below:
+key = { fg = "#ffffff", bg = "#000000", underline = { color = "#ff0000", style = "curl"}, modifiers = ["bold", "italic"] }
+Where key represents what you want to style, fg specifies the foreground color, bg the background color, underline the underline style/color, and modifiers is a list of style modifiers. bg, underline and modifiers can be omitted to defer to the defaults.
To specify only the foreground color:
+key = "#ffffff"
+If the key contains a dot '.', it must be quoted to prevent it being parsed as a dotted key.
"key.key" = "#ffffff"
+For inspiration, you can find the default theme.toml
+here and
+user-submitted themes
+here.
Using the linter
+Use the supplied linting tool to check for errors and missing scopes:
+cargo xtask themelint onedark # replace onedark with <name>
+The details of theme creation
+Color palettes
+It's recommended to define a palette of named colors, and refer to them in the
+configuration values in your theme. To do this, add a table called
+palette to your theme file:
"ui.background" = "white"
+"ui.text" = "black"
+
+[palette]
+white = "#ffffff"
+black = "#000000"
+Keep in mind that the [palette] table includes all keys after its header,
+so it should be defined after the normal theme options.
The default palette uses the terminal's default 16 colors, and the colors names
+are listed below. The [palette] section in the config file takes precedence
+over it and is merged into the default palette.
| Color Name |
|---|
default |
black |
red |
green |
yellow |
blue |
magenta |
cyan |
gray |
light-red |
light-green |
light-yellow |
light-blue |
light-magenta |
light-cyan |
light-gray |
white |
Modifiers
+The following values may be used as modifier, provided they are supported by +your terminal emulator.
+| Modifier |
|---|
bold |
dim |
italic |
underlined |
slow_blink |
rapid_blink |
reversed |
hidden |
crossed_out |
++💡 The
+underlinedmodifier is deprecated and only available for backwards compatibility. +Its behavior is equivalent to settingunderline.style="line".
Underline style
+One of the following values may be used as a value for underline.style, providing it is
+supported by your terminal emulator.
| Modifier |
|---|
line |
curl |
dashed |
dotted |
double_line |
Inheritance
+Extend other themes by setting the inherits property to an existing theme.
inherits = "boo_berry"
+
+# Override the theming for "keyword"s:
+"keyword" = { fg = "gold" }
+
+# Override colors in the palette:
+[palette]
+berry = "#2A2A4D"
+Rainbow
+The rainbow key is used for rainbow highlight for matching brackets.
+The key is a list of styles.
rainbow = ["#ff0000", "#ffa500", "#fff000", { fg = "#00ff00", modifiers = ["bold"] }]
+Colors from the palette and modifiers may be used.
+Scopes
+The following is a list of scopes available to use for styling:
+Syntax highlighting
+These keys match tree-sitter scopes.
+When determining styling for a highlight, the longest matching theme key will be used. For example, if the highlight is function.builtin.static, the key function.builtin will be used instead of function.
We use a similar set of scopes as +Sublime Text. See also +TextMate scopes.
+-
+
-
+
+attribute- Class attributes, HTML tag attributes
+ -
+
+type- Types-
+
builtin- Primitive types provided by the language (int,usize)
+parameter- Generic type parameters (T)
+enum+-
+
variant
+
+
+ -
+
+constructor
+ -
+
+constant(TODO: constant.other.placeholder for%v)-
+
builtinSpecial constants provided by the language (true,false,niletc) +-
+
boolean
+
+character+-
+
escape
+
+numeric(numbers) +-
+
integer
+float
+
+
+ -
+
+string(TODO: string.quoted.{single, double}, string.raw/.unquoted)?-
+
regexp- Regular expressions
+special+-
+
path
+url
+symbol- Erlang/Elixir atoms, Ruby symbols, Clojure keywords
+
+
+ -
+
+comment- Code comments-
+
line- Single line comments (//)
+block- Block comments (e.g. (/* */) +-
+
documentation- Documentation comments (e.g.///in Rust)
+
+
+ -
+
+variable- Variables-
+
builtin- Reserved language variables (self,this,super, etc.)
+parameter- Function parameters
+other+-
+
member- Fields of composite data types (e.g. structs, unions)
+
+
+ -
+
+label
+ -
+
+punctuation-
+
delimiter- Commas, colons
+bracket- Parentheses, angle brackets, etc.
+special- String interpolation brackets.
+
+ -
+
+keyword-
+
control+-
+
conditional-if,else
+repeat-for,while,loop
+import-import,export
+return
+exception
+
+operator-or,in
+directive- Preprocessor directives (#ifin C)
+function-fn,func
+storage- Keywords describing how things are stored +-
+
type- The type of something,class,function,var,let, etc.
+modifier- Storage modifiers likestatic,mut,const,ref, etc.
+
+
+ -
+
+operator-||,+=,>
+ -
+
+function-
+
builtin
+method
+macro
+special(preprocessor in C)
+
+ -
+
+tag- Tags (e.g.<body>in HTML)-
+
builtin
+
+ -
+
+namespace
+ -
+
+special
+ -
+
+markup-
+
heading+-
+
marker
+1,2,3,4,5,6- heading text for h1 through h6
+
+list+-
+
unnumbered
+numbered
+checked
+unchecked
+
+bold
+italic
+strikethrough
+link+-
+
url- URLs pointed to by links
+label- non-URL link references
+text- URL and image descriptions in links
+
+quote
+raw+-
+
inline
+block
+
+
+ -
+
+diff- version control changes-
+
plus- additions +-
+
gutter- gutter indicator
+
+minus- deletions +-
+
gutter- gutter indicator
+
+delta- modifications +-
+
moved- renamed or moved files/changes
+gutter- gutter indicator
+
+
+
Interface
+These scopes are used for theming the editor interface:
+-
+
markup+-
+
normal+-
+
completion- for completion doc popup UI
+hover- for hover popup UI
+
+heading+-
+
completion- for completion doc popup UI
+hover- for hover popup UI
+
+raw+-
+
inline+-
+
completion- for completion doc popup UI
+hover- for hover popup UI
+
+
+
+
| Key | Notes |
|---|---|
ui.background | |
ui.background.separator | Picker separator below input line |
ui.cursor | |
ui.cursor.normal | |
ui.cursor.insert | |
ui.cursor.select | |
ui.cursor.match | Matching bracket etc. |
ui.cursor.primary | Cursor with primary selection |
ui.cursor.primary.normal | |
ui.cursor.primary.insert | |
ui.cursor.primary.select | |
ui.debug.breakpoint | Breakpoint indicator, found in the gutter |
ui.debug.active | Indicator for the line at which debugging execution is paused at, found in the gutter |
ui.gutter | Gutter |
ui.gutter.selected | Gutter for the line the cursor is on |
ui.highlight.frameline | Line at which debugging execution is paused at |
ui.linenr | Line numbers |
ui.linenr.selected | Line number for the line the cursor is on |
ui.statusline | Statusline |
ui.statusline.inactive | Statusline (unfocused document) |
ui.statusline.normal | Statusline mode during normal mode (only if editor.color-modes is enabled) |
ui.statusline.insert | Statusline mode during insert mode (only if editor.color-modes is enabled) |
ui.statusline.select | Statusline mode during select mode (only if editor.color-modes is enabled) |
ui.statusline.separator | Separator character in statusline |
ui.bufferline | Style for the buffer line |
ui.bufferline.active | Style for the active buffer in buffer line |
ui.bufferline.background | Style for bufferline background |
ui.popup | Documentation popups (e.g. Space + k) |
ui.popup.info | Prompt for multiple key options |
ui.window | Borderlines separating splits |
ui.help | Description box for commands |
ui.text | Default text style, command prompts, popup text, etc. |
ui.text.focus | The currently selected line in the picker |
ui.text.inactive | Same as ui.text but when the text is inactive (e.g. suggestions) |
ui.text.info | The key: command text in ui.popup.info boxes |
ui.virtual.ruler | Ruler columns (see the editor.rulers config) |
ui.virtual.whitespace | Visible whitespace characters |
ui.virtual.indent-guide | Vertical indent width guides |
ui.virtual.inlay-hint | Default style for inlay hints of all kinds |
ui.virtual.inlay-hint.parameter | Style for inlay hints of kind parameter (LSPs are not required to set a kind) |
ui.virtual.inlay-hint.type | Style for inlay hints of kind type (LSPs are not required to set a kind) |
ui.virtual.wrap | Soft-wrap indicator (see the editor.soft-wrap config) |
ui.virtual.jump-label | Style for virtual jump labels |
ui.menu | Code and command completion menus |
ui.menu.selected | Selected autocomplete item |
ui.menu.scroll | fg sets thumb color, bg sets track color of scrollbar |
ui.selection | For selections in the editing area |
ui.selection.primary | |
ui.highlight | Highlighted lines in the picker preview |
ui.cursorline.primary | The line of the primary cursor (if cursorline is enabled) |
ui.cursorline.secondary | The lines of any other cursors (if cursorline is enabled) |
ui.cursorcolumn.primary | The column of the primary cursor (if cursorcolumn is enabled) |
ui.cursorcolumn.secondary | The columns of any other cursors (if cursorcolumn is enabled) |
warning | Diagnostics warning (gutter) |
error | Diagnostics error (gutter) |
info | Diagnostics info (gutter) |
hint | Diagnostics hint (gutter) |
diagnostic | Diagnostics fallback style (editing area) |
diagnostic.hint | Diagnostics hint (editing area) |
diagnostic.info | Diagnostics info (editing area) |
diagnostic.warning | Diagnostics warning (editing area) |
diagnostic.error | Diagnostics error (editing area) |
diagnostic.unnecessary | Diagnostics with unnecessary tag (editing area) |
diagnostic.deprecated | Diagnostics with deprecated tag (editing area) |
Key remapping
+Helix currently supports one-way key remapping through a simple TOML configuration +file. (More powerful solutions such as rebinding via commands will be +available in the future).
+To remap keys, create a config.toml file in your helix configuration
+directory (default ~/.config/helix on Linux systems) with a structure like
+this:
# At most one section each of 'keys.normal', 'keys.insert' and 'keys.select'
+[keys.normal]
+C-s = ":w" # Maps Ctrl-s to the typable command :w which is an alias for :write (save file)
+C-o = ":open ~/.config/helix/config.toml" # Maps Ctrl-o to opening of the helix config file
+a = "move_char_left" # Maps the 'a' key to the move_char_left command
+w = "move_line_up" # Maps the 'w' key move_line_up
+"C-S-esc" = "extend_line" # Maps Ctrl-Shift-Escape to extend_line
+g = { a = "code_action" } # Maps `ga` to show possible code actions
+"ret" = ["open_below", "normal_mode"] # Maps the enter key to open_below then re-enter normal mode
+
+[keys.insert]
+"A-x" = "normal_mode" # Maps Alt-X to enter normal mode
+j = { k = "normal_mode" } # Maps `jk` to exit insert mode
+Minor modes
+Minor modes are accessed by pressing a key (usually from normal mode), giving access to dedicated bindings. Bindings +can be modified or added by nesting definitions.
+[keys.insert.j]
+k = "normal_mode" # Maps `jk` to exit insert mode
+
+[keys.normal.g]
+a = "code_action" # Maps `ga` to show possible code actions
+
+# invert `j` and `k` in view mode
+[keys.normal.z]
+j = "scroll_up"
+k = "scroll_down"
+
+# create a new minor mode bound to `+`
+[keys.normal."+"]
+m = ":run-shell-command make"
+c = ":run-shell-command cargo build"
+t = ":run-shell-command cargo test"
+Special keys and modifiers
+Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
+C-, S- and A-. Special keys are encoded as follows:
| Key name | Representation |
|---|---|
| Backspace | "backspace" |
| Space | "space" |
| Return/Enter | "ret" |
| - | "minus" |
| Left | "left" |
| Right | "right" |
| Up | "up" |
| Down | "down" |
| Home | "home" |
| End | "end" |
| Page Up | "pageup" |
| Page Down | "pagedown" |
| Tab | "tab" |
| Delete | "del" |
| Insert | "ins" |
| Null | "null" |
| Escape | "esc" |
Keys can be disabled by binding them to the no_op command.
To remove all default bindings, unbind-default-keys = true can be added to the top level configuration.
unbind-default-keys = true
+
+# Only these normal mode bindings will be used
+[keys.normal]
+n = "normal_mode"
+t = "goto_definition"
+
+# remember to add bindings to return to normal mode
+[keys.select]
+esc = "normal_mode"
+
+[keys.insert]
+esc = "normal_mode"
+A list of commands is available in the Keymap documentation
+and in the source code at helix-term/src/commands.rs at the invocation of static_commands! macro and the TypableCommandList.
Languages
+Language-specific settings and settings for language servers are configured
+in languages.toml files.
languages.toml files
+There are three possible locations for a languages.toml file:
-
+
-
+
In the Helix source code, which lives in the +Helix repository. +It provides the default configurations for languages and language servers.
+
+ -
+
In your configuration directory. This overrides values +from the built-in language configuration. For example, to disable +auto-LSP-formatting in Rust:
+
+# in <config_dir>/helix/languages.toml + +[language-server.mylang-lsp] +command = "mylang-lsp" + +[[language]] +name = "rust" +auto-format = false +
+ -
+
In a
+.helixfolder in your project. Language configuration may also be +overridden local to a project by creating alanguages.tomlfile in a +.helixfolder. Its settings will be merged with the language configuration +in the configuration directory and the built-in configuration.
+
Language configuration
+Each language is configured by adding a [[language]] section to a
+languages.toml file. For example:
[[language]]
+name = "mylang"
+scope = "source.mylang"
+injection-regex = "mylang"
+file-types = ["mylang", "myl"]
+comment-tokens = "#"
+indent = { tab-width = 2, unit = " " }
+formatter = { command = "mylang-formatter" , args = ["--stdin"] }
+language-servers = [ "mylang-lsp" ]
+These configuration keys are available:
+| Key | Description |
|---|---|
name | The name of the language |
language-id | The language-id for language servers, checkout the table at TextDocumentItem for the right id |
scope | A string like source.js that identifies the language. Currently, we strive to match the scope names used by popular TextMate grammars and by the Linguist library. Usually source.<name> or text.<name> in case of markup languages |
injection-regex | regex pattern that will be tested against a language name in order to determine whether this language should be used for a potential language injection site. |
file-types | The filetypes of the language, for example ["yml", "yaml"]. See the file-type detection section below. |
shebangs | The interpreters from the shebang line, for example ["sh", "bash"] |
roots | A set of marker files to look for when trying to find the workspace root. For example Cargo.lock, yarn.lock |
auto-format | Whether to autoformat this language when saving |
diagnostic-severity | Minimal severity of diagnostic for it to be displayed. (Allowed values: Error, Warning, Info, Hint) |
comment-tokens | The tokens to use as a comment token, either a single token "//" or an array ["//", "///", "//!"] (the first token will be used for commenting). Also configurable as comment-token for backwards compatibility |
block-comment-tokens | The start and end tokens for a multiline comment either an array or single table of { start = "/*", end = "*/"}. The first set of tokens will be used for commenting, any pairs in the array can be uncommented |
indent | The indent to use. Has sub keys unit (the text inserted into the document when indenting; usually set to N spaces or "\t" for tabs) and tab-width (the number of spaces rendered for a tab) |
language-servers | The Language Servers used for this language. See below for more information in the section Configuring Language Servers for a language |
grammar | The tree-sitter grammar to use (defaults to the value of name) |
formatter | The formatter for the language, it will take precedence over the lsp when defined. The formatter must be able to take the original file as input from stdin and write the formatted file to stdout |
soft-wrap | editor.softwrap |
text-width | Maximum line length. Used for the :reflow command and soft-wrapping if soft-wrap.wrap-at-text-width is set, defaults to editor.text-width |
workspace-lsp-roots | Directories relative to the workspace root that are treated as LSP roots. Should only be set in .helix/config.toml. Overwrites the setting of the same name in config.toml if set. |
persistent-diagnostic-sources | An array of LSP diagnostic sources assumed unchanged when the language server resends the same set of diagnostics. Helix can track the position for these diagnostics internally instead. Useful for diagnostics that are recomputed on save. |
rulers | Overrides the editor.rulers config key for the language. |
rainbow-brackets | Overrides the editor.rainbow-brackets config key for the language. |
File-type detection and the file-types key
+Helix determines which language configuration to use based on the file-types key
+from the above section. file-types is a list of strings or tables, for
+example:
file-types = ["toml", { glob = "Makefile" }, { glob = ".git/config" }, { glob = ".github/workflows/*.yaml" } ]
+When determining a language configuration to use, Helix searches the file-types +with the following priorities:
+-
+
- Glob: values in
globtables are checked against the full path of the given +file. Globs are standard Unix-style path globs (e.g. the kind you use in Shell) +and can be used to match paths for a specific prefix, suffix, directory, etc. +In the above example, the{ glob = "Makefile" }config would match files +with the nameMakefile, the{ glob = ".git/config" }config would match +configfiles in.gitdirectories, and the{ glob = ".github/workflows/*.yaml" }+config would match anyyamlfiles in.github/workflowdirectories. Note +that globs should always use the Unix path separator/even on Windows systems; +the matcher will automatically take the machine-specific separators into account. +If the glob isn't an absolute path or doesn't already start with a glob prefix, +*/will automatically be added to ensure it matches for any subdirectory.
+ - Extension: if there are no glob matches, any
file-typesstring that matches +the file extension of a given file wins. In the example above, the"toml"+config matches files likeCargo.tomlorlanguages.toml.
+
Language Server configuration
+Language servers are configured separately in the table language-server in the same file as the languages languages.toml
For example:
+[language-server.mylang-lsp]
+command = "mylang-lsp"
+args = ["--stdio"]
+config = { provideFormatter = true }
+environment = { "ENV1" = "value1", "ENV2" = "value2" }
+
+[language-server.efm-lsp-prettier]
+command = "efm-langserver"
+
+[language-server.efm-lsp-prettier.config]
+documentFormatting = true
+languages = { typescript = [ { formatCommand ="prettier --stdin-filepath ${INPUT}", formatStdin = true } ] }
+These are the available options for a language server.
+| Key | Description |
|---|---|
command | The name or path of the language server binary to execute. Binaries must be in $PATH |
args | A list of arguments to pass to the language server binary |
config | LSP initialization options |
timeout | The maximum time a request to the language server may take, in seconds. Defaults to 20 |
environment | Any environment variables that will be used when starting the language server { "KEY1" = "Value1", "KEY2" = "Value2" } |
required-root-patterns | A list of glob patterns to look for in the working directory. The language server is started if at least one of them is found. |
A format sub-table within config can be used to pass extra formatting options to
+Document Formatting Requests.
+For example, with typescript:
[language-server.typescript-language-server]
+# pass format options according to https://github.com/typescript-language-server/typescript-language-server#workspacedidchangeconfiguration omitting the "[language].format." prefix.
+config = { format = { "semicolons" = "insert", "insertSpaceBeforeFunctionParenthesis" = true } }
+Configuring Language Servers for a language
+The language-servers attribute in a language tells helix which language servers are used for this language.
They have to be defined in the [language-server] table as described in the previous section.
Different languages can use the same language server instance, e.g. typescript-language-server is used for javascript, jsx, tsx and typescript by default.
In case multiple language servers are specified in the language-servers attribute of a language,
+it's often useful to only enable/disable certain language-server features for these language servers.
As an example, efm-lsp-prettier of the previous example is used only with a formatting command prettier,
+so everything else should be handled by the typescript-language-server (which is configured by default).
+The language configuration for typescript could look like this:
[[language]]
+name = "typescript"
+language-servers = [ { name = "efm-lsp-prettier", only-features = [ "format" ] }, "typescript-language-server" ]
+or equivalent:
+[[language]]
+name = "typescript"
+language-servers = [ { name = "typescript-language-server", except-features = [ "format" ] }, "efm-lsp-prettier" ]
+Each requested LSP feature is prioritized in the order of the language-servers array.
+For example, the first goto-definition supported language server (in this case typescript-language-server) will be taken for the relevant LSP request (command goto_definition).
+The features diagnostics, code-action, completion, document-symbols and workspace-symbols are an exception to that rule, as they are working for all language servers at the same time and are merged together, if enabled for the language.
+If no except-features or only-features is given, all features for the language server are enabled.
+If a language server itself doesn't support a feature, the next language server array entry will be tried (and so on).
The list of supported features is:
+-
+
format
+goto-definition
+goto-declaration
+goto-type-definition
+goto-reference
+goto-implementation
+signature-help
+hover
+document-highlight
+completion
+code-action
+workspace-command
+document-symbols
+workspace-symbols
+diagnostics
+rename-symbol
+inlay-hints
+
Tree-sitter grammar configuration
+The source for a language's tree-sitter grammar is specified in a [[grammar]]
+section in languages.toml. For example:
[[grammar]]
+name = "mylang"
+source = { git = "https://github.com/example/mylang", rev = "a250c4582510ff34767ec3b7dcdd3c24e8c8aa68" }
+Grammar configuration takes these keys:
+| Key | Description |
|---|---|
name | The name of the tree-sitter grammar |
source | The method of fetching the grammar - a table with a schema defined below |
Where source is a table with either these keys when using a grammar from a
+git repository:
| Key | Description |
|---|---|
git | A git remote URL from which the grammar should be cloned |
rev | The revision (commit hash or tag) which should be fetched |
subpath | A path within the grammar directory which should be built. Some grammar repositories host multiple grammars (for example tree-sitter-typescript and tree-sitter-ocaml) in subdirectories. This key is used to point hx --grammar build to the correct path for compilation. When omitted, the root of repository is used |
Choosing grammars
+You may use a top-level use-grammars key to control which grammars are
+fetched and built when using hx --grammar fetch and hx --grammar build.
# Note: this key must come **before** the [[language]] and [[grammar]] sections
+use-grammars = { only = [ "rust", "c", "cpp" ] }
+# or
+use-grammars = { except = [ "yaml", "json" ] }
+When omitted, all grammars are fetched and built.
+Guides
+This section contains guides for adding new language server configurations, +tree-sitter grammars, textobject and rainbow bracket queries, and other similar items.
+Adding new languages to Helix
+In order to add a new language to Helix, you will need to follow the steps +below.
+Language configuration
+-
+
- Add a new
[[language]]entry in thelanguages.tomlfile and provide the +necessary configuration for the new language. For more information on +language configuration, refer to the +language configuration section of the documentation. +A new language server can be added by extending the[language-server]table in the same file.
+ - If you are adding a new language or updating an existing language server
+configuration, run the command
cargo xtask docgento update the +Language Support documentation.
+
++💡 If you are adding a new Language Server configuration, make sure to update +the +Language Server Wiki +with the installation instructions.
+
Grammar configuration
+-
+
- If a tree-sitter grammar is available for the new language, add a new
+
[[grammar]]entry to thelanguages.tomlfile.
+ - If you are testing the grammar locally, you can use the
source.pathkey +with an absolute path to the grammar. However, before submitting a pull +request, make sure to switch to usingsource.git.
+
Queries
+-
+
- In order to provide syntax highlighting and indentation for the new language, +you will need to add queries. +
- Create a new directory for the language with the path
+
runtime/queries/<name>/.
+ - Refer to the +tree-sitter website +for more information on writing queries. +
- A list of highlight captures can be found on the themes page. +
++💡 In Helix, the first matching query takes precedence when evaluating +queries, which is different from other editors such as Neovim where the last +matching query supersedes the ones before it. See +this issue +for an example.
+
Common issues
+-
+
- If you encounter errors when running Helix after switching branches, you may
+need to update the tree-sitter grammars. Run the command
hx --grammar fetch+to fetch the grammars andhx --grammar buildto build any out-of-date +grammars.
+ - If a parser is causing a segfault, or you want to remove it, make sure to
+remove the compiled parser located at
runtime/grammars/<name>.so.
+ - If you are attempting to add queries and Helix is unable to locate them, ensure that the environment variable
HELIX_RUNTIMEis set to the location of theruntimefolder you're developing in.
+
Adding textobject queries
+Helix supports textobjects that are language specific, such as functions, classes, etc.
+These textobjects require an accompanying tree-sitter grammar and a textobjects.scm query file
+to work properly. Tree-sitter allows us to query the source code syntax tree
+and capture specific parts of it. The queries are written in a lisp dialect.
+More information on how to write queries can be found in the official tree-sitter
+documentation.
Query files should be placed in runtime/queries/{language}/textobjects.scm
+when contributing to Helix. Note that to test the query files locally you should put
+them under your local runtime directory (~/.config/helix/runtime on Linux
+for example).
The following captures are recognized:
+| Capture Name |
|---|
function.inside |
function.around |
class.inside |
class.around |
test.inside |
test.around |
parameter.inside |
comment.inside |
comment.around |
Example query files can be found in the helix GitHub repository.
+Queries for textobject based navigation
+Tree-sitter based navigation in Helix is done using captures in the +following order:
+-
+
object.movement
+object.around
+object.inside
+
For example if a function.around capture has been already defined for a language
+in its textobjects.scm file, function navigation should also work automatically.
+function.movement should be defined only if the node captured by function.around
+doesn't make sense in a navigation context.
Adding indent queries
+Helix uses tree-sitter to correctly indent new lines. This requires a tree-
+sitter grammar and an indent.scm query file placed in runtime/queries/ {language}/indents.scm. The indentation for a line is calculated by traversing
+the syntax tree from the lowest node at the beginning of the new line (see
+Indent queries). Each of these nodes contributes to the total
+indent when it is captured by the query (in what way depends on the name of
+the capture.
Note that it matters where these added indents begin. For example, +multiple indent level increases that start on the same line only increase +the total indent level by 1. See Capture types.
+By default, Helix uses the hybrid indentation heuristic. This means that
+indent queries are not used to compute the expected absolute indentation of a
+line but rather the expected difference in indentation between the new and an
+already existing line. This difference is then added to the actual indentation
+of the already existing line. Since this makes errors in the indent queries
+harder to find, it is recommended to disable it when testing via
+:set indent-heuristic tree-sitter. The rest of this guide assumes that
+the tree-sitter heuristic is used.
Indent queries
+When Helix is inserting a new line through o, O, or <ret>, to determine
+the indent level for the new line, the query in indents.scm is run on the
+document. The starting position of the query is the end of the line above where
+a new line will be inserted.
For o, the inserted line is the line below the cursor, so that starting
+position of the query is the end of the current line.
+#![allow(unused)] +fn main() { +fn need_hero(some_hero: Hero, life: Life) -> { + matches!(some_hero, Hero { // ←─────────────────╮ + strong: true,//←╮ ↑ ↑ │ + fast: true, // │ │ ╰── query start │ + sure: true, // │ ╰───── cursor ├─ traversal + soon: true, // ╰──────── new line inserted │ start node + }) && // │ +// ↑ │ +// ╰───────────────────────────────────────────────╯ + some_hero > life +} +}
For O, the newly inserted line is the current line, so the starting position
+of the query is the end of the line above the cursor.
+#![allow(unused)] +fn main() { +fn need_hero(some_hero: Hero, life: Life) -> { // ←─╮ + matches!(some_hero, Hero { // ←╮ ↑ │ + strong: true,// ↑ ╭───╯ │ │ + fast: true, // │ │ query start ─╯ │ + sure: true, // ╰───┼ cursor ├─ traversal + soon: true, // ╰ new line inserted │ start node + }) && // │ + some_hero > life // │ +} // ←──────────────────────────────────────────────╯ +}
From this starting node, the syntax tree is traversed up until the root node. +Each indent capture is collected along the way, and then combined according to +their capture types and scopes to a final indent +level for the line.
+Capture types
+-
+
@indent(default scopetail): +Increase the indent level by 1. Multiple occurrences in the same line do not +stack. If there is at least one@indentand one@outdentcapture on the +same line, the indent level isn't changed at all.
+@outdent(default scopeall): +Decrease the indent level by 1. The same rules as for@indentapply.
+@indent.always(default scopetail): +Increase the indent level by 1. Multiple occurrences on the same line do +stack. The final indent level is@indent.always–@outdent.always. If +an@indentand an@indent.alwaysare on the same line, the@indentis +ignored.
+@outdent.always(default scopeall): +Decrease the indent level by 1. The same rules as for@indent.alwaysapply.
+@align(default scopeall): +Align everything inside this node to some anchor. The anchor is given +by the start of the node captured by@anchorin the same pattern. +Every pattern with an@alignshould contain exactly one@anchor. +Indent (and outdent) for nodes below (in terms of their starting line) +the@alignnode is added to the indentation required for alignment.
+@extend: +Extend the range of this node to the end of the line and to lines that are +indented more than the line that this node starts on. This is useful for +languages like Python, where for the purpose of indentation some nodes (like +functions or classes) should also contain indented lines that follow them.
+@extend.prevent-once: +Prevents the first extension of an ancestor of this node. For example, in Python +a return expression always ends the block that it is in. Note that this only +stops the extension of the next@extendcapture. If multiple ancestors are +captured, only the extension of the innermost one is prevented. All other +ancestors are unaffected (regardless of whether the innermost ancestor would +actually have been extended).
+
@indent / @outdent
+Consider this example:
++#![allow(unused)] +fn main() { +fn shout(things: Vec<Thing>) { + // ↑ + // ├───────────────────────╮ indent level + // @indent ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄ + // │ + let it_all = |out| { things.filter(|thing| { // │ 1 + // ↑ ↑ │ + // ├───────────────────────┼─────┼┄┄┄┄┄┄┄┄┄┄┄┄┄┄ + // @indent @indent │ + // │ 2 + thing.can_do_with(out) // │ + })}; // ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄ + //↑↑↑ │ 1 +} //╰┼┴──────────────────────────────────────────────┴┄┄┄┄┄┄┄┄┄┄┄┄┄┄ +// 3x @outdent +}
((block) @indent)
+["}" ")"] @outdent
+Note how on the second line, we have two blocks begin on the same line. In this
+case, since both captures occur on the same line, they are combined and only
+result in a net increase of 1. Also note that the closing }s are part of the
+@indent captures, but the 3 @outdents also combine into 1 and result in that
+line losing one indent level.
@extend / @extend.prevent-once
+For an example of where @extend can be useful, consider Python, which is
+whitespace-sensitive.
]
+ (parenthesized_expression)
+ (function_definition)
+ (class_definition)
+] @indent
+
+class Hero:
+ def __init__(self, strong, fast, sure, soon):# ←─╮
+ self.is_strong = strong # │
+ self.is_fast = fast # ╭─── query start │
+ self.is_sure = sure # │ ╭─ cursor │
+ self.is_soon = soon # │ │ │
+ # ↑ ↑ │ │ │
+ # │ ╰──────╯ │ │
+ # ╰─────────────────────╯ │
+ # ├─ traversal
+ def need_hero(self, life): # │ start node
+ return ( # │
+ self.is_strong # │
+ and self.is_fast # │
+ and self.is_sure # │
+ and self.is_soon # │
+ and self > life # │
+ ) # ←─────────────────────────────────────────╯
+Without braces to catch the scope of the function, the smallest descendant of +the cursor on a line feed ends up being the entire inside of the class. Because +of this, it will miss the entire function node and its indent capture, leading +to an indent level one too small.
+To address this case, @extend tells helix to "extend" the captured node's span
+to the line feed and every consecutive line that has a greater indent level than
+the line of the node.
(parenthesized_expression) @indent
+
+]
+ (function_definition)
+ (class_definition)
+] @indent @extend
+
+class Hero:
+ def __init__(self, strong, fast, sure, soon):# ←─╮
+ self.is_strong = strong # │
+ self.is_fast = fast # ╭─── query start ├─ traversal
+ self.is_sure = sure # │ ╭─ cursor │ start node
+ self.is_soon = soon # │ │ ←───────────────╯
+ # ↑ ↑ │ │
+ # │ ╰──────╯ │
+ # ╰─────────────────────╯
+ def need_hero(self, life):
+ return (
+ self.is_strong
+ and self.is_fast
+ and self.is_sure
+ and self.is_soon
+ and self > life
+ )
+Furthermore, there are some cases where extending to everything with a greater
+indent level may not be desirable. Consider the need_hero function above. If
+our cursor is on the last line of the returned expression.
class Hero:
+ def __init__(self, strong, fast, sure, soon):
+ self.is_strong = strong
+ self.is_fast = fast
+ self.is_sure = sure
+ self.is_soon = soon
+
+ def need_hero(self, life):
+ return (
+ self.is_strong
+ and self.is_fast
+ and self.is_sure
+ and self.is_soon
+ and self > life
+ ) # ←─── cursor
+ #←────────── where cursor should go on new line
+In Python, the are a few tokens that will always end a scope, such as a return
+statement. Since the scope ends, so should the indent level. But because the
+function span is extended to every line with a greater indent level, a new line
+would just continue on the same level. And an @outdent would not help us here
+either, since it would cause everything in the parentheses to become outdented
+as well.
To help, we need to signal an end to the extension. We can do this with
+@extend.prevent-once.
(parenthesized_expression) @indent
+
+]
+ (function_definition)
+ (class_definition)
+] @indent @extend
+
+(return_statement) @extend.prevent-once
+@indent.always / @outdent.always
+As mentioned before, normally if there is more than one @indent or @outdent
+capture on the same line, they are combined.
Sometimes, there are cases when you may want to ensure that every indent capture +is additive, regardless of how many occur on the same line. Consider this +example in YAML.
+ - foo: bar
+# ↑ ↑
+# │ ╰─────────────── start of map
+# ╰───────────────── start of list element
+ baz: quux # ←─── cursor
+ # ←───────────── where the cursor should go on a new line
+ garply: waldo
+ - quux:
+ bar: baz
+ xyzzy: thud
+ fred: plugh
+In YAML, you often have lists of maps. In these cases, the syntax is such that
+the list element and the map both start on the same line. But we really do want
+to start an indentation for each of these so that subsequent keys in the map
+hang over the list and align properly. This is where @indent.always helps.
((block_sequence_item) @item @indent.always @extend
+ (#not-one-line? @item))
+
+((block_mapping_pair
+ key: (_) @key
+ value: (_) @val
+ (#not-same-line? @key @val)
+ ) @indent.always @extend
+)
+Predicates
+In some cases, an S-expression cannot express exactly what pattern should be matched.
+For that, tree-sitter allows for predicates to appear anywhere within a pattern,
+similar to how #set! declarations work:
(some_kind
+ (child_kind) @indent
+ (#predicate? arg1 arg2 ...)
+)
+The number of arguments depends on the predicate that's used.
+Each argument is either a capture (@name) or a string ("some string").
+The following predicates are supported by tree-sitter:
-
+
-
+
+#eq?/#not-eq?: +The first argument (a capture) must/must not be equal to the second argument +(a capture or a string).
+ -
+
+#match?/#not-match?: +The first argument (a capture) must/must not match the regex given in the +second argument (a string).
+ -
+
+#any-of?/#not-any-of?: +The first argument (a capture) must/must not be one of the other arguments +(strings).
+
Additionally, we support some custom predicates for indent queries:
+-
+
-
+
+#not-kind-eq?: +The kind of the first argument (a capture) must not be equal to the second +argument (a string).
+ -
+
+#same-line?/#not-same-line?: +The captures given by the 2 arguments must/must not start on the same line.
+ -
+
+#one-line?/#not-one-line?: +The captures given by the fist argument must/must span a total of one line.
+
Scopes
+Added indents don't always apply to the whole node. For example, in most +cases when a node should be indented, we actually only want everything +except for its first line to be indented. For this, there are several +scopes (more scopes may be added in the future if required):
+-
+
tail: +This scope applies to everything except for the first line of the +captured node.
+all: +This scope applies to the whole captured node. This is only different from +tailwhen the captured node is the first node on its line.
+
For example, imagine we have the following function
++#![allow(unused)] +fn main() { +fn aha() { // ←─────────────────────────────────────╮ + let take = "on me"; // ←──────────────╮ scope: │ + let take = "me on"; // ├─ "tail" ├─ (block) @indent + let ill = be_gone_days(1 || 2); // │ │ +} // ←───────────────────────────────────┴──────────┴─ "}" @outdent + // scope: "all" +}
We can write the following query with the #set! declaration:
((block) @indent
+ (#set! "scope" "tail"))
+("}" @outdent
+ (#set! "scope" "all"))
+As we can see, the "tail" scope covers the node, except for the first line.
+Everything up to and including the closing brace gets an indent level of 1.
+Then, on the closing brace, we encounter an outdent with a scope of "all", which
+means the first line is included, and the indent level is cancelled out on this
+line. (Note these scopes are the defaults for @indent and @outdent—they are
+written explicitly for demonstration.)
Adding Injection Queries
+Writing language injection queries allows one to highlight a specific node as a different language. +In addition to the standard language injection options used by tree-sitter, there +are a few Helix specific extensions that allow for more control.
+And example of a simple query that would highlight all strings as bash in Nix:
+((string_expression (string_fragment) @injection.content)
+ (#set! injection.language "bash"))
+Capture Types
+-
+
-
+
+@injection.language(standard): +The captured node may contain the language name used to highlight the node captured by +@injection.content.
+ -
+
+@injection.content(standard): +Marks the content to be highlighted as the language captured with@injection.languageet al.
+ -
+
+@injection.filename(extension): +The captured node may contain a filename with a file-extension known to Helix, +highlighting@injection.contentas that language. This uses the language extensions defined in +both the default languages.toml distributed with Helix, as well as user defined languages.
+ -
+
+@injection.shebang(extension): +The captured node may contain a shebang used to choose a language to highlight as. This also uses +the shebangs defined in the default and userlanguages.toml.
+
Settings
+-
+
-
+
+injection.combined(standard): +Indicates that all the matching nodes in the tree should have their content parsed as one +nested document.
+ -
+
+injection.language(standard): +Forces the captured content to be highlighted as the given language
+ -
+
+injection.include-children(standard): +Indicates that the content node’s entire text should be re-parsed, including the text of its child +nodes. By default, child nodes’ text will be excluded from the injected document.
+ -
+
+injection.include-unnamed-children(extension): +Same asinjection.include-childrenbut only for unnamed child nodes.
+
Predicates
+-
+
-
+
+#eq?(standard): +The first argument (a capture) must be equal to the second argument +(a capture or a string).
+ -
+
+#match?(standard): +The first argument (a capture) must match the regex given in the +second argument (a string).
+ -
+
+#any-of?(standard): +The first argument (a capture) must be one of the other arguments (strings).
+
Adding Rainbow Bracket Queries
+Helix uses rainbows.scm tree-sitter query files to provide rainbow bracket
+functionality.
Tree-sitter queries are documented in the tree-sitter online documentation. +If you're writing queries for the first time, be sure to check out the section +on syntax highlighting queries and on query syntax.
+Rainbow queries have two captures: @rainbow.scope and @rainbow.bracket.
+@rainbow.scope should capture any node that increases the nesting level
+while @rainbow.bracket should capture any bracket nodes. Put another way:
+@rainbow.scope switches to the next rainbow color for all nodes in the tree
+under it while @rainbow.bracket paints captured nodes with the current
+rainbow color.
For an example, let's add rainbow queries for the tree-sitter query (TSQ)
+language itself. These queries will go into a
+runtime/queries/tsq/rainbows.scm file in the repository root.
First we'll add the @rainbow.bracket captures. TSQ only has parentheses and
+square brackets:
["(" ")" "[" "]"] @rainbow.bracket
+The ordering of the nodes within the alternation (square brackets) is not +taken into consideration.
+++Note: Why are these nodes quoted? Most syntax highlights capture text +surrounded by parentheses. These are named nodes and correspond to the +names of rules in the grammar. Brackets are usually written in tree-sitter +grammars as literal strings, for example:
++{ + // ... + arguments: seq("(", repeat($.argument), ")"), + // ... +} +Nodes written as literal strings in tree-sitter grammars may be captured +in queries with those same literal strings.
+
Then we'll add @rainbow.scope captures. The easiest way to do this is to
+view the grammar.js file in the tree-sitter grammar's repository. For TSQ,
+that file is here. As we scroll down the grammar.js, we
+see that the (alternation), (L36) (group) (L57), (named_node) (L59),
+(predicate) (L87) and (wildcard_node) (L97) nodes all contain literal
+parentheses or square brackets in their definitions. These nodes are all
+direct parents of brackets and happen to also be the nodes we want to change
+to the next rainbow color, so we capture them as @rainbow.scope.
[
+ (group)
+ (named_node)
+ (wildcard_node)
+ (predicate)
+ (alternation)
+] @rainbow.scope
+This strategy works as a rule of thumb for most programming and configuration +languages. Markup languages can be trickier and may take additional +experimentation to find the correct nodes to use for scopes and brackets.
+The :tree-sitter-subtree command shows the syntax tree under the primary
+selection in S-expression format and can be a useful tool for determining how
+to write a query.
Properties
+The rainbow.include-children property may be applied to @rainbow.scope
+captures. By default, all @rainbow.bracket captures must be direct descendant
+of a node captured with @rainbow.scope in a syntax tree in order to be
+highlighted. The rainbow.include-children property disables that check and
+allows @rainbow.bracket captures to be highlighted if they are direct or
+indirect descendants of some node captured with @rainbow.scope.
For example, this property is used in the HTML rainbow queries.
+For a document like <a>link</a>, the syntax tree is:
(element ; <a>link</a>
+ (start_tag ; <a>
+ (tag_name)) ; a
+ (text) ; link
+ (end_tag ; </a>
+ (tag_name))) ; a
+If we want to highlight the <, > and </ nodes with rainbow colors, we
+capture them as @rainbow.bracket:
["<" ">" "</"] @rainbow.bracket
+And we capture (element) as @rainbow.scope because (element) nodes nest
+within each other: they increment the nesting level and switch to the next
+color in the rainbow.
(element) @rainbow.scope
+But this combination of @rainbow.scope and @rainbow.bracket will not
+highlight any nodes. <, > and </ are children of the (start_tag) and
+(end_tag) nodes. We can't capture (start_tag) and (end_tag) as
+@rainbow.scope because they don't nest other elements. We can fix this case
+by removing the requirement that <, > and </ are direct descendants of
+(element) using the rainbow.include-children property.
((element) @rainbow.scope
+ (#set! rainbow.include-children))
+With this property set, <, >, and </ will highlight with rainbow colors
+even though they aren't direct descendents of the (element) node.
rainbow.include-children is not necessary for the vast majority of programming
+languages. It is only necessary when the node that increments the nesting level
+(changes rainbow color) is not the direct parent of the bracket node.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/searcher.js b/master/searcher.js
new file mode 100644
index 00000000..dc03e0a0
--- /dev/null
+++ b/master/searcher.js
@@ -0,0 +1,483 @@
+"use strict";
+window.search = window.search || {};
+(function search(search) {
+ // Search functionality
+ //
+ // You can use !hasFocus() to prevent keyhandling in your key
+ // event handlers while the user is typing their search.
+
+ if (!Mark || !elasticlunr) {
+ return;
+ }
+
+ //IE 11 Compatibility from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/startsWith
+ if (!String.prototype.startsWith) {
+ String.prototype.startsWith = function(search, pos) {
+ return this.substr(!pos || pos < 0 ? 0 : +pos, search.length) === search;
+ };
+ }
+
+ var search_wrap = document.getElementById('search-wrapper'),
+ searchbar = document.getElementById('searchbar'),
+ searchbar_outer = document.getElementById('searchbar-outer'),
+ searchresults = document.getElementById('searchresults'),
+ searchresults_outer = document.getElementById('searchresults-outer'),
+ searchresults_header = document.getElementById('searchresults-header'),
+ searchicon = document.getElementById('search-toggle'),
+ content = document.getElementById('content'),
+
+ searchindex = null,
+ doc_urls = [],
+ results_options = {
+ teaser_word_count: 30,
+ limit_results: 30,
+ },
+ search_options = {
+ bool: "AND",
+ expand: true,
+ fields: {
+ title: {boost: 1},
+ body: {boost: 1},
+ breadcrumbs: {boost: 0}
+ }
+ },
+ mark_exclude = [],
+ marker = new Mark(content),
+ current_searchterm = "",
+ URL_SEARCH_PARAM = 'search',
+ URL_MARK_PARAM = 'highlight',
+ teaser_count = 0,
+
+ SEARCH_HOTKEY_KEYCODE = 83,
+ ESCAPE_KEYCODE = 27,
+ DOWN_KEYCODE = 40,
+ UP_KEYCODE = 38,
+ SELECT_KEYCODE = 13;
+
+ function hasFocus() {
+ return searchbar === document.activeElement;
+ }
+
+ function removeChildren(elem) {
+ while (elem.firstChild) {
+ elem.removeChild(elem.firstChild);
+ }
+ }
+
+ // Helper to parse a url into its building blocks.
+ function parseURL(url) {
+ var a = document.createElement('a');
+ a.href = url;
+ return {
+ source: url,
+ protocol: a.protocol.replace(':',''),
+ host: a.hostname,
+ port: a.port,
+ params: (function(){
+ var ret = {};
+ var seg = a.search.replace(/^\?/,'').split('&');
+ var len = seg.length, i = 0, s;
+ for (;i
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Key remapping
+Helix currently supports one-way key remapping through a simple TOML configuration +file. (More powerful solutions such as rebinding via commands will be +available in the future).
+To remap keys, create a config.toml file in your helix configuration
+directory (default ~/.config/helix on Linux systems) with a structure like
+this:
# At most one section each of 'keys.normal', 'keys.insert' and 'keys.select'
+[keys.normal]
+C-s = ":w" # Maps Ctrl-s to the typable command :w which is an alias for :write (save file)
+C-o = ":open ~/.config/helix/config.toml" # Maps Ctrl-o to opening of the helix config file
+a = "move_char_left" # Maps the 'a' key to the move_char_left command
+w = "move_line_up" # Maps the 'w' key move_line_up
+"C-S-esc" = "extend_line" # Maps Ctrl-Shift-Escape to extend_line
+g = { a = "code_action" } # Maps `ga` to show possible code actions
+"ret" = ["open_below", "normal_mode"] # Maps the enter key to open_below then re-enter normal mode
+
+[keys.insert]
+"A-x" = "normal_mode" # Maps Alt-X to enter normal mode
+j = { k = "normal_mode" } # Maps `jk` to exit insert mode
+Minor modes
+Minor modes are accessed by pressing a key (usually from normal mode), giving access to dedicated bindings. Bindings +can be modified or added by nesting definitions.
+[keys.insert.j]
+k = "normal_mode" # Maps `jk` to exit insert mode
+
+[keys.normal.g]
+a = "code_action" # Maps `ga` to show possible code actions
+
+# invert `j` and `k` in view mode
+[keys.normal.z]
+j = "scroll_up"
+k = "scroll_down"
+
+# create a new minor mode bound to `+`
+[keys.normal."+"]
+m = ":run-shell-command make"
+c = ":run-shell-command cargo build"
+t = ":run-shell-command cargo test"
+Special keys and modifiers
+Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
+C-, S- and A-. Special keys are encoded as follows:
| Key name | Representation |
|---|---|
| Backspace | "backspace" |
| Space | "space" |
| Return/Enter | "ret" |
| - | "minus" |
| Left | "left" |
| Right | "right" |
| Up | "up" |
| Down | "down" |
| Home | "home" |
| End | "end" |
| Page Up | "pageup" |
| Page Down | "pagedown" |
| Tab | "tab" |
| Delete | "del" |
| Insert | "ins" |
| Null | "null" |
| Escape | "esc" |
Keys can be disabled by binding them to the no_op command.
To remove all default bindings, unbind-default-keys = true can be added to the top level configuration.
unbind-default-keys = true
+
+# Only these normal mode bindings will be used
+[keys.normal]
+n = "normal_mode"
+t = "goto_definition"
+
+# remember to add bindings to return to normal mode
+[keys.select]
+esc = "normal_mode"
+
+[keys.insert]
+esc = "normal_mode"
+A list of commands is available in the Keymap documentation
+and in the source code at helix-term/src/commands.rs at the invocation of static_commands! macro and the TypableCommandList.