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 000000000..cb69f0df3
--- /dev/null
+++ b/master/configuration.html
@@ -0,0 +1,286 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Commands
+Command mode can be activated by pressing :, similar to vim. Built-in commands:
| Name | Description |
|---|---|
:quit, :q | Close the current view. |
:quit!, :q! | Close the current view forcefully (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! | Close all buffers but the currently focused one. |
:buffer-close-all, :bca, :bcloseall | Close all buffers, without quiting. |
:buffer-close-all!, :bca!, :bcloseall! | Close all buffers forcefully (ignoring unsaved changes), without quiting. |
:write, :w | Write changes to disk. Accepts an optional path (:write 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-8 for number of spaces.) |
:line-ending | Set the document's default line ending. Options: crlf, lf, cr, ff, nel. |
: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 views to disk. |
:write-quit-all, :wqa, :xa | Write changes from all views to disk and close all views. |
:write-quit-all!, :wqa!, :xa! | Write changes from all views to disk and close all views forcefully (ignoring unsaved changes). |
:quit-all, :qa | Close all views. |
:quit-all!, :qa! | Close all views forcefully (ignoring unsaved changes). |
:cquit, :cq | Quit with exit code (default 1). Accepts an optional integer exit code (:cq 2). |
:cquit!, :cq! | Quit with exit code (default 1) forcefully (ignoring unsaved changes). Accepts an optional integer exit code (:cq! 2). |
:theme | Change the editor theme. |
: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 |
:reload | Discard changes and reload from the source file. |
:tree-sitter-scopes | Display tree sitter scopes, primarily for theming and development. |
: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 | Go to line number. |
:set-option, :set | Set a config option at runtime |
:sort | Sort ranges in selection. |
:rsort | Sort ranges in selection in reverse order. |
:tree-sitter-subtree, :ts-subtree | Display tree sitter subtree under cursor, primarily for debugging queries. |
:config-reload | Refreshes helix's config. |
:config-open | Open the helix config.toml file. |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/css/chrome.css b/master/css/chrome.css
new file mode 100644
index 000000000..aba8a417b
--- /dev/null
+++ b/master/css/chrome.css
@@ -0,0 +1,499 @@
+/* CSS for UI elements (a.k.a. chrome) */
+
+@import 'variables.css';
+
+::-webkit-scrollbar {
+ background: var(--bg);
+}
+::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+html {
+ scrollbar-color: var(--scrollbar) var(--bg);
+}
+#searchresults a,
+.content a:link,
+a:visited,
+a > .hljs {
+ color: var(--links);
+}
+.content a:hover {
+ text-decoration: underline;
+}
+
+/* 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-bottom-color: var(--bg);
+ border-bottom-width: 1px;
+ border-bottom-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-bottom-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 {
+ 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-top: 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);
+}
+
+.previous {
+ float: left;
+}
+
+.next {
+ float: right;
+ right: var(--page-padding);
+}
+
+@media only screen and (max-width: 1080px) {
+ .nav-wide-wrapper { display: none; }
+ .nav-wrapper { display: block; }
+}
+
+@media only screen and (max-width: 1380px) {
+ .sidebar-visible .nav-wide-wrapper { display: none; }
+ .sidebar-visible .nav-wrapper { display: block; }
+}
+
+/* Inline code */
+
+:not(pre) > .hljs {
+ display: inline;
+ padding: 0.1em 0.3em;
+ border-radius: 3px;
+}
+
+:not(pre):not(a):not(td):not(p) > .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: 5px;
+ top: 5px;
+
+ color: var(--sidebar-fg);
+ cursor: pointer;
+}
+pre > .buttons :hover {
+ color: var(--sidebar-active);
+}
+pre > .buttons i {
+ margin-left: 8px;
+}
+pre > .buttons button {
+ color: inherit;
+ background: transparent;
+ border: none;
+ cursor: inherit;
+}
+pre > .result {
+ margin-top: 10px;
+}
+
+/* Search */
+
+#searchresults a {
+ text-decoration: none;
+}
+
+mark {
+ border-radius: 2px;
+ padding: 0 3px 1px 3px;
+ margin: 0 -3px -1px -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-left: auto;
+ margin-right: auto;
+ max-width: var(--content-max-width);
+}
+
+#searchbar {
+ width: 100%;
+ margin: 5px auto 0px 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: 18px 0 0 5px;
+ color: var(--searchresults-header-fg);
+}
+
+.searchresults-outer {
+ margin-left: auto;
+ margin-right: auto;
+ max-width: var(--content-max-width);
+ border-bottom: 1px dashed var(--searchresults-border-color);
+}
+
+ul#searchresults {
+ list-style: none;
+ padding-left: 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: 5px 0 0 20px;
+ 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);
+}
+.sidebar-resizing {
+ -moz-user-select: none;
+ -webkit-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+.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;
+}
+.sidebar .sidebar-resize-handle {
+ position: absolute;
+ cursor: col-resize;
+ width: 0;
+ right: 0;
+ top: 0;
+ bottom: 0;
+}
+.js .sidebar .sidebar-resize-handle {
+ cursor: col-resize;
+ width: 5px;
+}
+.sidebar-hidden .sidebar {
+ transform: translateX(calc(0px - var(--sidebar-width)));
+}
+.sidebar::-webkit-scrollbar {
+ background: var(--sidebar-bg);
+}
+.sidebar::-webkit-scrollbar-thumb {
+ background: var(--scrollbar);
+}
+
+.sidebar-visible .page-wrapper {
+ transform: translateX(var(--sidebar-width));
+}
+@media only screen and (min-width: 620px) {
+ .sidebar-visible .page-wrapper {
+ transform: none;
+ margin-left: var(--sidebar-width);
+ }
+}
+
+.chapter {
+ list-style: none outside none;
+ padding-left: 0;
+ margin: .25rem 0;
+}
+
+.chapter ol {
+ width: 100%;
+}
+
+.chapter li {
+ display: flex;
+ color: var(--sidebar-non-existant);
+}
+.chapter li a {
+ display: block;
+ 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-left: 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 {
+ padding: 1rem 1.5rem;
+}
+
+.chapter .section li.chapter-item {
+ padding: .5rem .5rem 0 .5rem;
+}
+
+.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-left: 2rem;
+ 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;
+}
+.theme-popup .default {
+ color: var(--icons);
+}
+.theme-popup .theme {
+ width: 100%;
+ border: 0;
+ margin: 0;
+ padding: 2px 10px;
+ line-height: 25px;
+ white-space: nowrap;
+ text-align: left;
+ cursor: pointer;
+ color: inherit;
+ background: inherit;
+ font-size: inherit;
+}
+.theme-popup .theme:hover {
+ background-color: var(--theme-hover);
+}
+.theme-popup .theme:hover:first-child,
+.theme-popup .theme:hover:last-child {
+ border-top-left-radius: inherit;
+ border-top-right-radius: inherit;
+}
diff --git a/master/css/general.css b/master/css/general.css
new file mode 100644
index 000000000..9b280d08a
--- /dev/null
+++ b/master/css/general.css
@@ -0,0 +1,233 @@
+/* Base styles and content styles */
+
+@import 'variables.css';
+
+:root {
+ /* Browser default font-size is 16px, this way 1 rem = 10px */
+ font-size: 62.5%;
+}
+
+/* TODO: replace with self hosted fonts */
+
+html {
+ font-family: "Inter", sans-serif;
+ color: var(--fg);
+ background-color: var(--bg);
+ text-size-adjust: none;
+}
+
+/* @supports (font-variation-settings: normal) { */
+/* html { font-family: 'Inter var', sans-serif; } */
+/* } */
+
+body {
+ margin: 0;
+ font-size: 1.6rem;
+ overflow-x: hidden;
+}
+
+code {
+ font-family: "Source Code Pro", Consolas, "Ubuntu Mono", Menlo, "DejaVu Sans Mono", monospace, monospace !important;
+ font-size: 0.875em; /* please adjust the ace font size accordingly in editor.js */
+}
+
+/* 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-top: 2.5em; }
+h4, h5 { margin-top: 2em; }
+
+.header + .header h3,
+.header + .header h4,
+.header + .header h5 {
+ margin-top: 1em;
+}
+
+h1:target::before,
+h2:target::before,
+h3:target::before,
+h4:target::before,
+h5:target::before,
+h6:target::before {
+ display: inline-block;
+ content: "»";
+ margin-left: -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 {
+ scroll-margin-top: calc(var(--menu-bar-height) + 0.5em);
+}
+
+.page {
+ outline: 0;
+ padding: 0 var(--page-padding);
+ margin-top: calc(0px - var(--menu-bar-height)); /* Compensate for the #menu-bar-hover-placeholder */
+}
+.page-wrapper {
+ box-sizing: border-box;
+}
+.js:not(.sidebar-resizing) .page-wrapper {
+ transition: margin-left 0.3s ease, transform 0.3s ease; /* Animation: slide away */
+}
+
+.content {
+ overflow-y: auto;
+ padding: 0 15px;
+ padding-bottom: 50px;
+}
+.content main {
+ margin-left: auto;
+ margin-right: auto;
+ max-width: var(--content-max-width);
+}
+
+
+/* 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;
+}
+
+.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 { max-width: 100%; }
+.content .header:link,
+.content .header:visited {
+ color: var(--fg);
+ color: var(--heading-fg);
+}
+.content .header:link,
+.content .header:visited:hover {
+ text-decoration: none;
+}
+
+table {
+ margin: 0 auto;
+ border-collapse: collapse;
+ width: 100%;
+}
+table td {
+ padding: .75rem;
+ width: auto;
+}
+table thead {
+ background: var(--table-header-bg);
+}
+table thead td {
+ font-weight: 700;
+ border: none;
+}
+table thead th {
+ padding: .75rem;
+ text-align: left;
+ font-weight: 500;
+ line-height: 1.5;
+ width: auto;
+}
+table thead tr {
+ border-bottom: 2px var(--table-border-color) solid;
+}
+table tbody tr {
+ border-bottom: 1px var(--table-border-line) solid;
+}
+/* Alternate background colors for rows */
+table tbody tr:nth-child(2n) {
+ /* background: var(--table-alternate-bg); */
+}
+
+
+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);
+}
+blockquote *:last-child {
+ margin-bottom: 0;
+}
+
+
+:not(.footnote-definition) + .footnote-definition,
+.footnote-definition + :not(.footnote-definition) {
+ margin-top: 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 000000000..5e690f755
--- /dev/null
+++ b/master/css/print.css
@@ -0,0 +1,54 @@
+
+#sidebar,
+#menu-bar,
+.nav-chapters,
+.mobile-nav-chapters {
+ display: none;
+}
+
+#page-wrapper.page-wrapper {
+ transform: none;
+ margin-left: 0px;
+ overflow-y: initial;
+}
+
+#content {
+ max-width: none;
+ margin: 0;
+ padding: 0;
+}
+
+.page {
+ overflow-y: initial;
+}
+
+code {
+ background-color: #666666;
+ border-radius: 5px;
+
+ /* Force background to be printed in Chrome */
+ -webkit-print-color-adjust: exact;
+}
+
+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 000000000..b62c75581
--- /dev/null
+++ b/master/css/variables.css
@@ -0,0 +1,342 @@
+
+/* Globals */
+
+:root {
+ --sidebar-width: 300px;
+ --page-padding: 15px;
+ --content-max-width: 750px;
+ --menu-bar-height: 50px;
+}
+
+/* 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%);
+
+ --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;
+}
+
+.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%);
+
+ --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;
+}
+
+.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%);
+
+ --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;
+}
+
+.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%);
+
+ --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;
+}
+
+.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%);
+
+ --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;
+}
+
+@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%);
+
+ --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;
+ }
+}
+
+.colibri {
+ --bg: #3b224c;
+ --fg: #bcbdd0;
+ --heading-fg: #fff;
+
+ --sidebar-bg: #281733;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #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 {
+/*
+ --bg: #ffffff;
+ --fg: #452859;
+ --fg: #5a5977;
+ --heading-fg: #281733;
+
+ --sidebar-bg: #281733;
+ --sidebar-fg: #c8c9db;
+ --sidebar-non-existant: #505274;
+ --sidebar-active: #a4a0e8;
+ --sidebar-spacer: #2d334f;
+
+ --scrollbar: var(--sidebar-fg);
+
+ --icons: #737480;
+ --icons-hover: #b7b9cc;
+
+ --links: #6F44F0;
+
+ --inline-code-color: #a39e9b;
+
+ --theme-popup-bg: #161923;
+ --theme-popup-border: #737480;
+ --theme-hover: rgba(0,0,0, .2);
+
+ --quote-bg: rgba(0, 0, 0, 0);
+ --quote-border: hsl(226, 15%, 75%);
+
+ --table-border-color: #5a5977;
+ --table-border-color: hsl(201deg 10% 67%);
+ --table-header-bg: hsl(0, 0%, 100%);
+ --table-alternate-bg: hsl(0, 0%, 97%);
+ --table-border-line: hsl(201deg, 20%, 92%);
+
+ --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;
+*/
+}
diff --git a/master/elasticlunr.min.js b/master/elasticlunr.min.js
new file mode 100644
index 000000000..94b20dd2e
--- /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
+
++Hint: 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
+Editor
+[editor] Section
+| Key | Description | Default |
|---|---|---|
scrolloff | Number of lines of padding around the edge of the screen when scrolling. | 3 |
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 |
auto-completion | Enable automatic pop up of auto-completion. | true |
idle-timeout | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | 400 |
completion-trigger-len | The min-length of word under cursor to trigger autocompletion | 2 |
auto-info | Whether to display infoboxes | true |
true-color | Set to true to override automatic detection of terminal truecolor support in the event of a false negative. | false |
[editor.lsp] Section
+| Key | Description | Default |
|---|---|---|
display-messages | Display LSP progress messages below statusline1 | false |
1
+
+A progress spinner is always shown in the statusline beside the file path.
+[editor.cursor-shape] Section
+Defines the shape of cursor in each mode. Note that 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
+Sets options for file picker and global search. All but the last key listed in
+the default file-picker configuration below are IgnoreOptions: whether hidden
+files and files listed within ignore files are ignored by (not visible in) the
+helix file picker and global search. There is also one other key, max-depth
+available, which is not defined by default.
| Key | Description | Default |
|---|---|---|
hidden | Enables ignoring hidden files. | 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.excludefile option. | true |
git-exclude | Enables reading .git/info/exclude files. | true |
max-depth | Set with an integer value for maximum depth to recurse. | Defaults to None. |
[editor.auto-pairs] Section
+Enable automatic insertion of pairs to parentheses, brackets, etc. Can be +a simple boolean value, or a specific mapping of pairs of single characters.
+| Key | Description |
|---|---|
false | Completely disable auto pairing, regardless of language-specific settings |
true | Use the default pairs: (){}[]''""`` |
| Mapping of pairs | e.g. { "(" = ")", "{" = "}", ... } |
Example
+[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 |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/adding_languages.html b/master/guides/adding_languages.html
new file mode 100644
index 000000000..fc5b57109
--- /dev/null
+++ b/master/guides/adding_languages.html
@@ -0,0 +1,253 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 the 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.
+++ +TODO: Mention texobjects, surround, registers
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/index.html b/master/guides/index.html
new file mode 100644
index 000000000..e1440f726
--- /dev/null
+++ b/master/guides/index.html
@@ -0,0 +1,182 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Adding languages
+Language configuration
+To add a new language, you need to add a language entry to the
+languages.toml found in the root of the repository;
+this languages.toml file is included at compilation time, and is
+distinct from the languages.toml file in the user's configuration
+directory.
[[language]]
+name = "mylang"
+scope = "scope.mylang"
+injection-regex = "^mylang$"
+file-types = ["mylang", "myl"]
+comment-token = "#"
+indent = { tab-width = 2, unit = " " }
+These are the available keys and descriptions for the file.
+| Key | Description |
|---|---|
name | The name of the language |
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"]. Extensions and full file names are supported. |
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-token | The token to use as a comment-token |
indent | The indent to use. Has sub keys tab-width and unit |
config | Language server configuration |
grammar | The tree-sitter grammar to use (defaults to the value of name) |
Grammar configuration
+If a tree-sitter grammar is available for the language, add a new grammar
+entry to languages.toml.
[[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 |
Or a path key with an absolute path to a locally available grammar directory.
Queries
+For a language to have syntax-highlighting and indentation among
+other things, you have to add queries. Add a directory for your
+language with the path runtime/queries/<name>/. The tree-sitter
+website
+gives more info on how to write queries.
++NOTE: When evaluating queries, the first matching query takes +precedence, which is different from other editors like neovim where +the last matching query supersedes the ones before it. See +this issue for an example.
+
Common Issues
+-
+
-
+
If you get errors when running after switching branches, you may have to update the tree-sitter grammars. Run
+hx --grammar fetchto fetch the grammars andhx --grammar buildto build any out-of-date grammars.
+ -
+
If a parser is segfaulting or you want to remove the parser, make sure to remove the compiled parser in
+runtime/grammar/<name>.so
+ -
+
The indents query is
+indents.toml, notindents.scm. See this issue for more information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/guides/textobject.html b/master/guides/textobject.html
new file mode 100644
index 000000000..dd83c1f21
--- /dev/null
+++ b/master/guides/textobject.html
@@ -0,0 +1,207 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Guides
+This section contains guides for adding new language server configurations, +tree-sitter grammers, textobject queries, etc.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/highlight.css b/master/highlight.css
new file mode 100644
index 000000000..8dce7d65f
--- /dev/null
+++ b/master/highlight.css
@@ -0,0 +1,56 @@
+pre code.hljs {
+ display:block;
+ overflow-x:auto;
+ padding:1em
+}
+code.hljs {
+ padding:3px 5px
+}
+.hljs {
+ background:#2f1e2e;
+ color:#a39e9b
+}
+.hljs-comment,
+.hljs-quote {
+ color:#8d8687
+}
+.hljs-link,
+.hljs-meta,
+.hljs-name,
+.hljs-regexp,
+.hljs-selector-class,
+.hljs-selector-id,
+.hljs-tag,
+.hljs-template-variable,
+.hljs-variable {
+ color:#ef6155
+}
+.hljs-built_in,
+.hljs-deletion,
+.hljs-literal,
+.hljs-number,
+.hljs-params,
+.hljs-type {
+ color:#f99b15
+}
+.hljs-attribute,
+.hljs-section,
+.hljs-title {
+ color:#fec418
+}
+.hljs-addition,
+.hljs-bullet,
+.hljs-string,
+.hljs-symbol {
+ color:#48b685
+}
+.hljs-keyword,
+.hljs-selector-tag {
+ color:#815ba4
+}
+.hljs-emphasis {
+ font-style:italic
+}
+.hljs-strong {
+ font-weight:700
+}
diff --git a/master/highlight.js b/master/highlight.js
new file mode 100644
index 000000000..180385b70
--- /dev/null
+++ b/master/highlight.js
@@ -0,0 +1,6 @@
+/*
+ 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
+Textobjects that are language specific (like functions, classes, etc)
+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. 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 |
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 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 it's 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/index.html b/master/index.html
new file mode 100644
index 000000000..4cdbcb46f
--- /dev/null
+++ b/master/index.html
@@ -0,0 +1,180 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hooks
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/install.html b/master/install.html
new file mode 100644
index 000000000..315a6ce62
--- /dev/null
+++ b/master/install.html
@@ -0,0 +1,217 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+Refer the FAQ for common questions.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/keymap.html b/master/keymap.html
new file mode 100644
index 000000000..56c4ffd50
--- /dev/null
+++ b/master/keymap.html
@@ -0,0 +1,500 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+We provide pre-built binaries on the GitHub Releases page.
+
OSX
+A Homebrew tap is available:
+brew tap helix-editor/helix
+brew install helix
+Linux
+NixOS
+A flake containing the package is available in
+the project root. The flake can also be used to spin up a reproducible development
+shell for working on Helix with nix develop.
Flake outputs are cached for each push to master using
+Cachix. With Cachix
+installed, cachix use helix will
+configure Nix to use cached outputs when possible.
Arch Linux
+Releases are available in the community repository.
A helix-git package is also available on the AUR, which builds the master branch.
+Fedora Linux
+You can install the COPR package for Helix via
+sudo dnf copr enable varlad/helix
+sudo dnf install helix
+Build from source
+git clone https://github.com/helix-editor/helix
+cd helix
+cargo install --path helix-term
+This will install the hx binary to $HOME/.cargo/bin.
Helix also needs it's runtime files so make sure to copy/symlink the runtime/ directory into the
+config directory (for example ~/.config/helix/runtime on Linux/macOS). This location can be overriden
+via the HELIX_RUNTIME environment variable.
Building tree-sitter grammars
+Tree-sitter grammars must be fetched and compiled if not pre-packaged.
+Fetch grammars with hx --grammar fetch (requires git) and compile them
+with hx --grammar build (requires a C compiler).
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/lang-support.html b/master/lang-support.html
new file mode 100644
index 000000000..2fc30f867
--- /dev/null
+++ b/master/lang-support.html
@@ -0,0 +1,252 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keymap
+-
+
- Mappings marked (LSP) require an active language server for the file. +
- Mappings marked (TS) require a tree-sitter grammar for the filetype. +
Normal mode
+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_line_down |
k, Up | Move up | move_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 or m) | 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 half page up | half_page_up |
Ctrl-d | Move half page down | half_page_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 | prepend_to_line |
A | Insert at the end of the line | append_to_line |
o | Open new line below selection | open_below |
O | Open new line above selection | open_above |
. | Repeat last change | 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 subselections on regex matches | split_selection |
Alt-s | Split selection on newlines | split_selection_on_newline |
& | 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 |
X | Extend selection to line bounds (line-wise selection) | extend_to_line_bounds |
J | Join lines inside selection | join_selections |
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-k, Alt-up | Expand selection to parent syntax node (TS) | expand_selection |
Alt-j, Alt-down | Shrink syntax tree object selection (TS) | shrink_selection |
Alt-h, Alt-left | Select previous sibling node in syntax tree (TS) | select_prev_sibling |
Alt-l, Alt-right | Select next sibling node in syntax tree (TS) | select_next_sibling |
Search
+Search commands all operate on the / register by default. Use "<char> to operate on a different one.
| 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 |
View mode
+View mode is intended for scrolling and manipulating the view without changing +the selection. The "sticky" variant of this mode is persistent; use the Escape +key to return to normal mode after usage (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-d | Move half page down | half_page_down |
Ctrl-u | Move half page up | half_page_up |
Goto 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 selection | 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 |
Match mode
+Enter this mode using m from normal mode. See the relavant 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
+This layer is similar to vim keybindings as kakoune does not support window.
+| 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 selection in horizontal splits | goto_file |
F | Go to files in the selection 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 |
Space mode
+This layer is a kludge of mappings, mostly pickers.
+| Key | Description | Command |
|---|---|---|
f | Open file picker | file_picker |
b | Open buffer picker | buffer_picker |
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 |
r | Rename symbol (LSP) | rename_symbol |
a | Apply code action (LSP) | code_action |
' | Open last fuzzy picker | last_picker |
w | Enter window mode | N/A |
p | Paste system clipboard after selections | paste_clipboard_after |
P | Paste system clipboard before selections | paste_clipboard_before |
y | Join and yank selections to clipboard | yank_joined_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 |
++TIP: 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
+Mappings in the style of vim-unimpaired.
+| Key | Description | Command |
|---|---|---|
[d | Go to previous diagnostic (LSP) | goto_prev_diag |
]d | Go to next diagnostic (LSP) | goto_next_diag |
[D | Go to first diagnostic in document (LSP) | goto_first_diag |
]D | Go to last diagnostic in document (LSP) | goto_last_diag |
]f | Go to next function (TS) | goto_next_function |
[f | Go to previous function (TS) | goto_prev_function |
]c | Go to next class (TS) | goto_next_class |
[c | Go to previous class (TS) | goto_prev_class |
]a | Go to next argument/parameter (TS) | goto_next_parameter |
[a | Go to previous argument/parameter (TS) | goto_prev_parameter |
]o | Go to next comment (TS) | goto_next_comment |
[o | Go to previous comment (TS) | goto_prev_comment |
[space | Add newline above | add_newline_above |
]space | Add newline below | add_newline_below |
Insert Mode
+We support many readline/emacs style bindings in insert mode for +convenience. These can be helpful for making simple modifications +without escaping to normal mode, but beware that you will not have an +undo-able "save point" until you return to normal mode.
+| Key | Description | Command |
|---|---|---|
Escape | Switch to normal mode | normal_mode |
Ctrl-x | Autocomplete | completion |
Ctrl-r | Insert a register content | insert_register |
Ctrl-w, Alt-Backspace | Delete previous word | delete_word_backward |
Alt-d | Delete next word | delete_word_forward |
Alt-b, Alt-Left | Backward a word | move_prev_word_end |
Ctrl-b, Left | Backward a char | move_char_left |
Alt-f, Alt-Right | Forward a word | move_next_word_start |
Ctrl-f, Right | Forward a char | move_char_right |
Ctrl-e, End | Move to line end | goto_line_end_newline |
Ctrl-a, Home | Move to line start | goto_line_start |
Ctrl-u | Delete to start of line | kill_to_line_start |
Ctrl-k | Delete to end of line | kill_to_line_end |
Ctrl-j, Enter | Insert new line | insert_newline |
Backspace, Ctrl-h | Delete previous char | delete_char_backward |
Delete, Ctrl-d | Delete previous char | delete_char_forward |
Ctrl-p, Up | Move to previous line | move_line_up |
Ctrl-n, Down | Move to next line | move_line_down |
PageUp | Move one page up | page_up |
PageDown | Move one page down | page_down |
Alt-> | Go to end of buffer | goto_file_end |
Alt-< | Go to start of buffer | goto_file_start |
Select / extend mode
+This 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 |
|---|---|
Up, Ctrl-k, Ctrl-p | Previous entry |
PageUp, Ctrl-b | Page up |
Down, Ctrl-j, Ctrl-n | Next entry |
PageDown, Ctrl-f | Page down |
Home | Go to first entry |
End | Go to last entry |
Ctrl-space | Filter options |
Enter | Open selected |
Ctrl-s | Open horizontally |
Ctrl-v | Open vertically |
Escape, Ctrl-c | Close picker |
Prompt
+Keys to use within prompt, Remapping currently not supported.
+| Key | Description |
|---|---|
Escape, Ctrl-c | Close prompt |
Alt-b, Alt-Left | Backward a word |
Ctrl-b, Left | Backward a char |
Alt-f, Alt-Right | Forward a word |
Ctrl-f, Right | Forward a char |
Ctrl-e, End | Move prompt end |
Ctrl-a, Home | Move prompt start |
Ctrl-w | Delete previous word |
Alt-d | Delete next word |
Ctrl-u | Delete to start of line |
Ctrl-k | Delete to end of line |
backspace, Ctrl-h | 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 |
Tab | Select next completion item |
BackTab | Select previous completion item |
Enter | Open selected |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/languages.html b/master/languages.html
new file mode 100644
index 000000000..7742eb75b
--- /dev/null
+++ b/master/languages.html
@@ -0,0 +1,207 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Language Support
+For more information like arguments passed to default LSP server,
+extensions assosciated with a filetype, custom LSP settings, filetype
+specific indent settings, etc see the default
+languages.toml file.
| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Default LSP |
|---|---|---|---|---|
| bash | ✓ | bash-language-server | ||
| c | ✓ | ✓ | ✓ | clangd |
| c-sharp | ✓ | OmniSharp | ||
| cmake | ✓ | ✓ | ✓ | cmake-language-server |
| comment | ✓ | |||
| cpp | ✓ | ✓ | ✓ | clangd |
| css | ✓ | |||
| dart | ✓ | ✓ | dart | |
| dockerfile | ✓ | docker-langserver | ||
| elixir | ✓ | elixir-ls | ||
| elm | ✓ | elm-language-server | ||
| erlang | ✓ | |||
| fish | ✓ | ✓ | ✓ | |
| git-commit | ✓ | |||
| git-config | ✓ | |||
| git-diff | ✓ | |||
| git-rebase | ✓ | |||
| glsl | ✓ | ✓ | ||
| go | ✓ | ✓ | ✓ | gopls |
| graphql | ✓ | |||
| haskell | ✓ | haskell-language-server-wrapper | ||
| hcl | ✓ | ✓ | terraform-ls | |
| html | ✓ | |||
| iex | ✓ | |||
| java | ✓ | |||
| javascript | ✓ | ✓ | typescript-language-server | |
| json | ✓ | ✓ | ||
| julia | ✓ | julia | ||
| kotlin | ✓ | kotlin-language-server | ||
| latex | ✓ | |||
| lean | ✓ | lean | ||
| ledger | ✓ | |||
| llvm | ✓ | ✓ | ✓ | |
| llvm-mir | ✓ | ✓ | ✓ | |
| llvm-mir-yaml | ✓ | ✓ | ||
| lua | ✓ | ✓ | ||
| make | ✓ | |||
| markdown | ✓ | |||
| mint | mint | |||
| nix | ✓ | ✓ | rnix-lsp | |
| ocaml | ✓ | ✓ | ||
| ocaml-interface | ✓ | |||
| org | ✓ | |||
| perl | ✓ | ✓ | ✓ | |
| php | ✓ | ✓ | ✓ | |
| prolog | swipl | |||
| protobuf | ✓ | ✓ | ||
| python | ✓ | ✓ | ✓ | pylsp |
| racket | racket | |||
| regex | ✓ | |||
| rescript | ✓ | ✓ | rescript-language-server | |
| ruby | ✓ | ✓ | solargraph | |
| rust | ✓ | ✓ | ✓ | rust-analyzer |
| scala | ✓ | ✓ | metals | |
| solidity | ✓ | solc | ||
| svelte | ✓ | ✓ | svelteserver | |
| tablegen | ✓ | ✓ | ✓ | |
| toml | ✓ | |||
| tsq | ✓ | |||
| tsx | ✓ | typescript-language-server | ||
| twig | ✓ | |||
| typescript | ✓ | ✓ | typescript-language-server | |
| vue | ✓ | |||
| wgsl | ✓ | |||
| yaml | ✓ | ✓ | ||
| zig | ✓ | ✓ | zls |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/mark.min.js b/master/mark.min.js
new file mode 100644
index 000000000..163623188
--- /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
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Languages
+Language-specific settings and settings for particular language servers can be configured in a languages.toml file placed in your configuration directory. Helix actually uses two languages.toml files, the first one is in the main helix repository; it contains the default settings for each language and is included in the helix binary at compile time. Users who want to see the available settings and options can either reference the helix repo's languages.toml file, or consult the table in the adding languages section.
Changes made to the languages.toml file in a user's configuration directory are merged with helix's defaults on start-up, such that a user's settings will take precedence over defaults in the event of a collision. For example, the default languages.toml sets rust's auto-format to true. If a user wants to disable auto-format, they can change the languages.toml in their configuration directory to make the rust entry read like the example below; the new key/value pair auto-format = false will override the default when the two sets of settings are merged on start-up:
# in <config_dir>/helix/languages.toml
+
+[[language]]
+name = "rust"
+auto-format = false
+Tree-sitter grammars
+Tree-sitter grammars can also be configured in languages.toml:
# in <config_dir>/helix/languages.toml
+
+[[grammar]]
+name = "rust"
+source = { git = "https://github.com/tree-sitter/tree-sitter-rust", rev = "a250c4582510ff34767ec3b7dcdd3c24e8c8aa68" }
+
+[[grammar]]
+name = "c"
+source = { path = "/path/to/tree-sitter-c" }
+You may use a top-level use-grammars key to control which grammars are fetched and built.
# 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 000000000..abb82f4c3
--- /dev/null
+++ b/master/remapping.html
@@ -0,0 +1,234 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+Refer the FAQ for common questions.
+Installation
+We provide pre-built binaries on the GitHub Releases page.
+
OSX
+A Homebrew tap is available:
+brew tap helix-editor/helix
+brew install helix
+Linux
+NixOS
+A flake containing the package is available in
+the project root. The flake can also be used to spin up a reproducible development
+shell for working on Helix with nix develop.
Flake outputs are cached for each push to master using
+Cachix. With Cachix
+installed, cachix use helix will
+configure Nix to use cached outputs when possible.
Arch Linux
+Releases are available in the community repository.
A helix-git package is also available on the AUR, which builds the master branch.
+Fedora Linux
+You can install the COPR package for Helix via
+sudo dnf copr enable varlad/helix
+sudo dnf install helix
+Build from source
+git clone https://github.com/helix-editor/helix
+cd helix
+cargo install --path helix-term
+This will install the hx binary to $HOME/.cargo/bin.
Helix also needs it's runtime files so make sure to copy/symlink the runtime/ directory into the
+config directory (for example ~/.config/helix/runtime on Linux/macOS). This location can be overriden
+via the HELIX_RUNTIME environment variable.
Building tree-sitter grammars
+Tree-sitter grammars must be fetched and compiled if not pre-packaged.
+Fetch grammars with hx --grammar fetch (requires git) and compile them
+with hx --grammar build (requires a C compiler).
Usage
+(Currently not fully documented, see the keymappings list for more.)
+See tutor.txt (accessible via hx --tutor or :tutor) for a vimtutor-like introduction.
Registers
+Vim-like registers can be used to yank and store text to be pasted later. Usage is similar, with " being used to select a register:
-
+
"ay- Yank the current selection to registera.
+"op- Paste the text in registeroafter the selection.
+
If there is a selected register 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.
+
Special Registers
+| Register character | Contains |
|---|---|
/ | Last search |
: | Last executed command |
" | Last yanked text |
_ | Black hole |
++There is no special register for copying to system clipboard, instead special commands and keybindings are provided. See the keymap for the specifics. +The black hole register works as a no-op register, meaning no data will be written to / read from it.
+
Surround
+Functionality similar to vim-surround is built into +helix. The keymappings have been inspired from vim-sandwich:
+
-
+
ms- Add surround characters
+mr- Replace surround characters
+md- Delete surround characters
+
ms acts on a selection, so select the text first and use ms<char>. mr and md work
+on the closest pairs found and selections are not required; use counts to act in outer pairs.
It can also act on multiple selections (yay!). 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 parens with square brackets
+
Multiple characters are currently not supported, but planned.
+Textobjects
+Currently supported: word, surround, function, class, parameter.
+
-
+
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 |
(, [, ', etc | Specified surround pairs |
f | Function |
c | Class |
a | Argument/parameter |
o | Comment |
++NOTE:
+f,c, 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!
Tree-sitter Textobject Based Navigation
+Navigating between functions, classes, parameters, etc is made
+possible by leveraging tree-sitter and textobjects queries. For
+example to move to the next function use ]f, to move to previous
+class use [c, and so on.
See the unimpaired section of the keybind +documentation for the full reference.
+++NOTE: This feature is dependent on tree-sitter based textobjects +and therefore requires the corresponding query file to work properly.
+
Keymap
+-
+
- Mappings marked (LSP) require an active language server for the file. +
- Mappings marked (TS) require a tree-sitter grammar for the filetype. +
Normal mode
+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_line_down |
k, Up | Move up | move_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 or m) | 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 half page up | half_page_up |
Ctrl-d | Move half page down | half_page_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 | prepend_to_line |
A | Insert at the end of the line | append_to_line |
o | Open new line below selection | open_below |
O | Open new line above selection | open_above |
. | Repeat last change | 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 subselections on regex matches | split_selection |
Alt-s | Split selection on newlines | split_selection_on_newline |
& | 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 |
X | Extend selection to line bounds (line-wise selection) | extend_to_line_bounds |
J | Join lines inside selection | join_selections |
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-k, Alt-up | Expand selection to parent syntax node (TS) | expand_selection |
Alt-j, Alt-down | Shrink syntax tree object selection (TS) | shrink_selection |
Alt-h, Alt-left | Select previous sibling node in syntax tree (TS) | select_prev_sibling |
Alt-l, Alt-right | Select next sibling node in syntax tree (TS) | select_next_sibling |
Search
+Search commands all operate on the / register by default. Use "<char> to operate on a different one.
| 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 |
View mode
+View mode is intended for scrolling and manipulating the view without changing +the selection. The "sticky" variant of this mode is persistent; use the Escape +key to return to normal mode after usage (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-d | Move half page down | half_page_down |
Ctrl-u | Move half page up | half_page_up |
Goto 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 selection | 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 |
Match mode
+Enter this mode using m from normal mode. See the relavant 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
+This layer is similar to vim keybindings as kakoune does not support window.
+| 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 selection in horizontal splits | goto_file |
F | Go to files in the selection 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 |
Space mode
+This layer is a kludge of mappings, mostly pickers.
+| Key | Description | Command |
|---|---|---|
f | Open file picker | file_picker |
b | Open buffer picker | buffer_picker |
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 |
r | Rename symbol (LSP) | rename_symbol |
a | Apply code action (LSP) | code_action |
' | Open last fuzzy picker | last_picker |
w | Enter window mode | N/A |
p | Paste system clipboard after selections | paste_clipboard_after |
P | Paste system clipboard before selections | paste_clipboard_before |
y | Join and yank selections to clipboard | yank_joined_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 |
++TIP: 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
+Mappings in the style of vim-unimpaired.
+| Key | Description | Command |
|---|---|---|
[d | Go to previous diagnostic (LSP) | goto_prev_diag |
]d | Go to next diagnostic (LSP) | goto_next_diag |
[D | Go to first diagnostic in document (LSP) | goto_first_diag |
]D | Go to last diagnostic in document (LSP) | goto_last_diag |
]f | Go to next function (TS) | goto_next_function |
[f | Go to previous function (TS) | goto_prev_function |
]c | Go to next class (TS) | goto_next_class |
[c | Go to previous class (TS) | goto_prev_class |
]a | Go to next argument/parameter (TS) | goto_next_parameter |
[a | Go to previous argument/parameter (TS) | goto_prev_parameter |
]o | Go to next comment (TS) | goto_next_comment |
[o | Go to previous comment (TS) | goto_prev_comment |
[space | Add newline above | add_newline_above |
]space | Add newline below | add_newline_below |
Insert Mode
+We support many readline/emacs style bindings in insert mode for +convenience. These can be helpful for making simple modifications +without escaping to normal mode, but beware that you will not have an +undo-able "save point" until you return to normal mode.
+| Key | Description | Command |
|---|---|---|
Escape | Switch to normal mode | normal_mode |
Ctrl-x | Autocomplete | completion |
Ctrl-r | Insert a register content | insert_register |
Ctrl-w, Alt-Backspace | Delete previous word | delete_word_backward |
Alt-d | Delete next word | delete_word_forward |
Alt-b, Alt-Left | Backward a word | move_prev_word_end |
Ctrl-b, Left | Backward a char | move_char_left |
Alt-f, Alt-Right | Forward a word | move_next_word_start |
Ctrl-f, Right | Forward a char | move_char_right |
Ctrl-e, End | Move to line end | goto_line_end_newline |
Ctrl-a, Home | Move to line start | goto_line_start |
Ctrl-u | Delete to start of line | kill_to_line_start |
Ctrl-k | Delete to end of line | kill_to_line_end |
Ctrl-j, Enter | Insert new line | insert_newline |
Backspace, Ctrl-h | Delete previous char | delete_char_backward |
Delete, Ctrl-d | Delete previous char | delete_char_forward |
Ctrl-p, Up | Move to previous line | move_line_up |
Ctrl-n, Down | Move to next line | move_line_down |
PageUp | Move one page up | page_up |
PageDown | Move one page down | page_down |
Alt-> | Go to end of buffer | goto_file_end |
Alt-< | Go to start of buffer | goto_file_start |
Select / extend mode
+This 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 |
|---|---|
Up, Ctrl-k, Ctrl-p | Previous entry |
PageUp, Ctrl-b | Page up |
Down, Ctrl-j, Ctrl-n | Next entry |
PageDown, Ctrl-f | Page down |
Home | Go to first entry |
End | Go to last entry |
Ctrl-space | Filter options |
Enter | Open selected |
Ctrl-s | Open horizontally |
Ctrl-v | Open vertically |
Escape, Ctrl-c | Close picker |
Prompt
+Keys to use within prompt, Remapping currently not supported.
+| Key | Description |
|---|---|
Escape, Ctrl-c | Close prompt |
Alt-b, Alt-Left | Backward a word |
Ctrl-b, Left | Backward a char |
Alt-f, Alt-Right | Forward a word |
Ctrl-f, Right | Forward a char |
Ctrl-e, End | Move prompt end |
Ctrl-a, Home | Move prompt start |
Ctrl-w | Delete previous word |
Alt-d | Delete next word |
Ctrl-u | Delete to start of line |
Ctrl-k | Delete to end of line |
backspace, Ctrl-h | 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 |
Tab | Select next completion item |
BackTab | Select previous completion item |
Enter | Open selected |
Commands
+Command mode can be activated by pressing :, similar to vim. Built-in commands:
| Name | Description |
|---|---|
:quit, :q | Close the current view. |
:quit!, :q! | Close the current view forcefully (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! | Close all buffers but the currently focused one. |
:buffer-close-all, :bca, :bcloseall | Close all buffers, without quiting. |
:buffer-close-all!, :bca!, :bcloseall! | Close all buffers forcefully (ignoring unsaved changes), without quiting. |
:write, :w | Write changes to disk. Accepts an optional path (:write 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-8 for number of spaces.) |
:line-ending | Set the document's default line ending. Options: crlf, lf, cr, ff, nel. |
: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 views to disk. |
:write-quit-all, :wqa, :xa | Write changes from all views to disk and close all views. |
:write-quit-all!, :wqa!, :xa! | Write changes from all views to disk and close all views forcefully (ignoring unsaved changes). |
:quit-all, :qa | Close all views. |
:quit-all!, :qa! | Close all views forcefully (ignoring unsaved changes). |
:cquit, :cq | Quit with exit code (default 1). Accepts an optional integer exit code (:cq 2). |
:cquit!, :cq! | Quit with exit code (default 1) forcefully (ignoring unsaved changes). Accepts an optional integer exit code (:cq! 2). |
:theme | Change the editor theme. |
: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 |
:reload | Discard changes and reload from the source file. |
:tree-sitter-scopes | Display tree sitter scopes, primarily for theming and development. |
: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 | Go to line number. |
:set-option, :set | Set a config option at runtime |
:sort | Sort ranges in selection. |
:rsort | Sort ranges in selection in reverse order. |
:tree-sitter-subtree, :ts-subtree | Display tree sitter subtree under cursor, primarily for debugging queries. |
:config-reload | Refreshes helix's config. |
:config-open | Open the helix config.toml file. |
Language Support
+For more information like arguments passed to default LSP server,
+extensions assosciated with a filetype, custom LSP settings, filetype
+specific indent settings, etc see the default
+languages.toml file.
| Language | Syntax Highlighting | Treesitter Textobjects | Auto Indent | Default LSP |
|---|---|---|---|---|
| bash | ✓ | bash-language-server | ||
| c | ✓ | ✓ | ✓ | clangd |
| c-sharp | ✓ | OmniSharp | ||
| cmake | ✓ | ✓ | ✓ | cmake-language-server |
| comment | ✓ | |||
| cpp | ✓ | ✓ | ✓ | clangd |
| css | ✓ | |||
| dart | ✓ | ✓ | dart | |
| dockerfile | ✓ | docker-langserver | ||
| elixir | ✓ | elixir-ls | ||
| elm | ✓ | elm-language-server | ||
| erlang | ✓ | |||
| fish | ✓ | ✓ | ✓ | |
| git-commit | ✓ | |||
| git-config | ✓ | |||
| git-diff | ✓ | |||
| git-rebase | ✓ | |||
| glsl | ✓ | ✓ | ||
| go | ✓ | ✓ | ✓ | gopls |
| graphql | ✓ | |||
| haskell | ✓ | haskell-language-server-wrapper | ||
| hcl | ✓ | ✓ | terraform-ls | |
| html | ✓ | |||
| iex | ✓ | |||
| java | ✓ | |||
| javascript | ✓ | ✓ | typescript-language-server | |
| json | ✓ | ✓ | ||
| julia | ✓ | julia | ||
| kotlin | ✓ | kotlin-language-server | ||
| latex | ✓ | |||
| lean | ✓ | lean | ||
| ledger | ✓ | |||
| llvm | ✓ | ✓ | ✓ | |
| llvm-mir | ✓ | ✓ | ✓ | |
| llvm-mir-yaml | ✓ | ✓ | ||
| lua | ✓ | ✓ | ||
| make | ✓ | |||
| markdown | ✓ | |||
| mint | mint | |||
| nix | ✓ | ✓ | rnix-lsp | |
| ocaml | ✓ | ✓ | ||
| ocaml-interface | ✓ | |||
| org | ✓ | |||
| perl | ✓ | ✓ | ✓ | |
| php | ✓ | ✓ | ✓ | |
| prolog | swipl | |||
| protobuf | ✓ | ✓ | ||
| python | ✓ | ✓ | ✓ | pylsp |
| racket | racket | |||
| regex | ✓ | |||
| rescript | ✓ | ✓ | rescript-language-server | |
| ruby | ✓ | ✓ | solargraph | |
| rust | ✓ | ✓ | ✓ | rust-analyzer |
| scala | ✓ | ✓ | metals | |
| solidity | ✓ | solc | ||
| svelte | ✓ | ✓ | svelteserver | |
| tablegen | ✓ | ✓ | ✓ | |
| toml | ✓ | |||
| tsq | ✓ | |||
| tsx | ✓ | typescript-language-server | ||
| twig | ✓ | |||
| typescript | ✓ | ✓ | typescript-language-server | |
| vue | ✓ | |||
| wgsl | ✓ | |||
| yaml | ✓ | ✓ | ||
| 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 the 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.
+++TODO: Mention texobjects, 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
+
++Hint: 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
+Editor
+[editor] Section
+| Key | Description | Default |
|---|---|---|
scrolloff | Number of lines of padding around the edge of the screen when scrolling. | 3 |
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 |
auto-completion | Enable automatic pop up of auto-completion. | true |
idle-timeout | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | 400 |
completion-trigger-len | The min-length of word under cursor to trigger autocompletion | 2 |
auto-info | Whether to display infoboxes | true |
true-color | Set to true to override automatic detection of terminal truecolor support in the event of a false negative. | false |
[editor.lsp] Section
+| Key | Description | Default |
|---|---|---|
display-messages | Display LSP progress messages below statusline1 | false |
1
+
+A progress spinner is always shown in the statusline beside the file path.
+[editor.cursor-shape] Section
+Defines the shape of cursor in each mode. Note that 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
+Sets options for file picker and global search. All but the last key listed in
+the default file-picker configuration below are IgnoreOptions: whether hidden
+files and files listed within ignore files are ignored by (not visible in) the
+helix file picker and global search. There is also one other key, max-depth
+available, which is not defined by default.
| Key | Description | Default |
|---|---|---|
hidden | Enables ignoring hidden files. | 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.excludefile option. | true |
git-exclude | Enables reading .git/info/exclude files. | true |
max-depth | Set with an integer value for maximum depth to recurse. | Defaults to None. |
[editor.auto-pairs] Section
+Enable automatic insertion of pairs to parentheses, brackets, etc. Can be +a simple boolean value, or a specific mapping of pairs of single characters.
+| Key | Description |
|---|---|
false | Completely disable auto pairing, regardless of language-specific settings |
true | Use the default pairs: (){}[]''""`` |
| Mapping of pairs | e.g. { "(" = ")", "{" = "}", ... } |
Example
+[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 |
Themes
+To use a theme add theme = "<name>" to your config.toml at the very top of the file before the first section or select it during runtime using :theme <name>.
Creating a theme
+Create a file with the name of your theme as file name (i.e mytheme.toml) and place it in your themes directory (i.e ~/.config/helix/themes). The directory might have to be created beforehand.
The names "default" and "base16_default" are reserved for the builtin themes and cannot be overridden by user defined themes.
+The default theme.toml can be found here, and user submitted themes here.
+Each line in the theme file is specified as below:
+key = { fg = "#ffffff", bg = "#000000", modifiers = ["bold", "italic"] }
+where key represents what you want to style, fg specifies the foreground color, bg the background color, and modifiers is a list of style modifiers. bg 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"
+Color palettes
+It's recommended define a palette of named colors, and refer to them from 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"
+Remember that the [palette] table includes all keys after its header,
+so you should define the palette after 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 |
|---|
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 modifiers.
+Less common modifiers might not be supported by your terminal emulator.
+| Modifier |
|---|
bold |
dim |
italic |
underlined |
slow_blink |
rapid_blink |
reversed |
hidden |
crossed_out |
Scopes
+The following is a list of scopes available to use for styling.
+Syntax highlighting
+These keys match tree-sitter scopes.
+For a given highlight produced, styling will be determined based on the longest matching theme key. For example, the highlight function.builtin.static would match the key function.builtin rather than function.
We use a similar set of scopes as +SublimeText. See also +TextMate scopes.
+-
+
-
+
+type- Types-
+
builtin- Primitive types provided by the language (int,usize)
+
+ -
+
+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)
+
+function(TODO: ?)
+
+ -
+
+label
+ -
+
+punctuation-
+
delimiter- Commas, colons
+bracket- Parentheses, angle brackets, etc.
+
+ -
+
+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
+
+ -
+
+operator-||,+=,>
+ -
+
+function-
+
builtin
+method
+macro
+special(preprocesor in C)
+
+ -
+
+tag- Tags (e.g.<body>in HTML)
+ -
+
+namespace
+ -
+
+markup-
+
heading+-
+
marker
+1,2,3,4,5,6- heading text for h1 through h6
+
+list+-
+
unnumbered
+numbered
+
+bold
+italic
+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
+minus- deletions
+delta- modifications +-
+
moved- renamed or moved files/changes
+
+
+
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.cursor | |
ui.cursor.insert | |
ui.cursor.select | |
ui.cursor.match | Matching bracket etc. |
ui.cursor.primary | Cursor with primary selection |
ui.linenr | |
ui.linenr.selected | |
ui.statusline | Statusline |
ui.statusline.inactive | Statusline (unfocused document) |
ui.popup | |
ui.popup.info | |
ui.window | |
ui.help | |
ui.text | |
ui.text.focus | |
ui.text.info | |
ui.menu | |
ui.menu.selected | |
ui.selection | For selections in the editing area |
ui.selection.primary | |
warning | Diagnostics warning (gutter) |
error | Diagnostics error (gutter) |
info | Diagnostics info (gutter) |
hint | Diagnostics hint (gutter) |
diagnostic | For text in editing area |
Key Remapping
+One-way key remapping is temporarily supported via a simple TOML configuration +file. (More powerful solutions such as rebinding via commands will be +available in the future).
+To remap keys, write a config.toml file in your helix configuration
+directory (default ~/.config/helix in 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 the Control-s to the typable command :w which is an alias for :write (save file)
+C-o = ":open ~/.config/helix/config.toml" # Maps the Control-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 Control-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
+++NOTE: Typable commands can also be remapped, remember to keep the
+:prefix to indicate it's a typable command.
Control, 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" |
| < | "lt" |
| > | "gt" |
| + | "plus" |
| - | "minus" |
| ; | "semicolon" |
| % | "percent" |
| 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.
Commands can be found at Keymap Commands.
+++Commands can also be found in the source code at
+helix-term/src/commands.rsat the invocation ofstatic_commands!macro and theTypableCommandList.
Hooks
+Languages
+Language-specific settings and settings for particular language servers can be configured in a languages.toml file placed in your configuration directory. Helix actually uses two languages.toml files, the first one is in the main helix repository; it contains the default settings for each language and is included in the helix binary at compile time. Users who want to see the available settings and options can either reference the helix repo's languages.toml file, or consult the table in the adding languages section.
Changes made to the languages.toml file in a user's configuration directory are merged with helix's defaults on start-up, such that a user's settings will take precedence over defaults in the event of a collision. For example, the default languages.toml sets rust's auto-format to true. If a user wants to disable auto-format, they can change the languages.toml in their configuration directory to make the rust entry read like the example below; the new key/value pair auto-format = false will override the default when the two sets of settings are merged on start-up:
# in <config_dir>/helix/languages.toml
+
+[[language]]
+name = "rust"
+auto-format = false
+Tree-sitter grammars
+Tree-sitter grammars can also be configured in languages.toml:
# in <config_dir>/helix/languages.toml
+
+[[grammar]]
+name = "rust"
+source = { git = "https://github.com/tree-sitter/tree-sitter-rust", rev = "a250c4582510ff34767ec3b7dcdd3c24e8c8aa68" }
+
+[[grammar]]
+name = "c"
+source = { path = "/path/to/tree-sitter-c" }
+You may use a top-level use-grammars key to control which grammars are fetched and built.
# 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 grammers, textobject queries, etc.
+Adding languages
+Language configuration
+To add a new language, you need to add a language entry to the
+languages.toml found in the root of the repository;
+this languages.toml file is included at compilation time, and is
+distinct from the languages.toml file in the user's configuration
+directory.
[[language]]
+name = "mylang"
+scope = "scope.mylang"
+injection-regex = "^mylang$"
+file-types = ["mylang", "myl"]
+comment-token = "#"
+indent = { tab-width = 2, unit = " " }
+These are the available keys and descriptions for the file.
+| Key | Description |
|---|---|
name | The name of the language |
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"]. Extensions and full file names are supported. |
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-token | The token to use as a comment-token |
indent | The indent to use. Has sub keys tab-width and unit |
config | Language server configuration |
grammar | The tree-sitter grammar to use (defaults to the value of name) |
Grammar configuration
+If a tree-sitter grammar is available for the language, add a new grammar
+entry to languages.toml.
[[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 |
Or a path key with an absolute path to a locally available grammar directory.
Queries
+For a language to have syntax-highlighting and indentation among
+other things, you have to add queries. Add a directory for your
+language with the path runtime/queries/<name>/. The tree-sitter
+website
+gives more info on how to write queries.
++NOTE: When evaluating queries, the first matching query takes +precedence, which is different from other editors like neovim where +the last matching query supersedes the ones before it. See +this issue for an example.
+
Common Issues
+-
+
-
+
If you get errors when running after switching branches, you may have to update the tree-sitter grammars. Run
+hx --grammar fetchto fetch the grammars andhx --grammar buildto build any out-of-date grammars.
+ -
+
If a parser is segfaulting or you want to remove the parser, make sure to remove the compiled parser in
+runtime/grammar/<name>.so
+ -
+
The indents query is
+indents.toml, notindents.scm. See this issue for more information.
+
Adding Textobject Queries
+Textobjects that are language specific (like functions, classes, etc)
+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. 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 |
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 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 it's 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.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/master/searcher.js b/master/searcher.js
new file mode 100644
index 000000000..d2b0aeed3
--- /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
+One-way key remapping is temporarily supported via a simple TOML configuration +file. (More powerful solutions such as rebinding via commands will be +available in the future).
+To remap keys, write a config.toml file in your helix configuration
+directory (default ~/.config/helix in 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 the Control-s to the typable command :w which is an alias for :write (save file)
+C-o = ":open ~/.config/helix/config.toml" # Maps the Control-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 Control-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
+++NOTE: Typable commands can also be remapped, remember to keep the
+:prefix to indicate it's a typable command.
Control, 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" |
| < | "lt" |
| > | "gt" |
| + | "plus" |
| - | "minus" |
| ; | "semicolon" |
| % | "percent" |
| 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.
Commands can be found at Keymap Commands.
+++ +Commands can also be found in the source code at
+helix-term/src/commands.rsat the invocation ofstatic_commands!macro and theTypableCommandList.