2024-07-14 20:20:42 +04:00
<!DOCTYPE HTML>
2024-11-26 02:58:22 +04:00
< html lang = "en" class = "colibri sidebar-visible" dir = "ltr" >
2024-07-14 20:20:42 +04:00
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Usage< / title >
<!-- Custom HTML head -->
2024-11-11 07:31:10 +04:00
2024-07-14 20:20:42 +04:00
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
< link rel = "stylesheet" href = "custom.css" >
2024-11-26 02:58:22 +04:00
2024-07-14 20:20:42 +04:00
<!-- Provide site root to javascript -->
< script >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "colibri" : "colibri";
< / script >
2024-11-26 02:58:22 +04:00
<!-- Start loading toc.js asap -->
< script src = "toc.js" > < / script >
< / head >
< body >
< div id = "body-container" >
2024-07-14 20:20:42 +04:00
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
2024-11-26 02:58:22 +04:00
const html = document.documentElement;
2024-07-14 20:20:42 +04:00
html.classList.remove('colibri')
html.classList.add(theme);
2024-11-26 02:58:22 +04:00
html.classList.add("js");
2024-07-14 20:20:42 +04:00
< / script >
< input type = "checkbox" id = "sidebar-toggle-anchor" class = "hidden" >
<!-- Hide / unhide sidebar before it is displayed -->
< script >
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
2024-11-26 02:58:22 +04:00
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
2024-07-14 20:20:42 +04:00
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
2024-11-26 02:58:22 +04:00
<!-- populated by js -->
< mdbook-sidebar-scrollbox class = "sidebar-scrollbox" > < / mdbook-sidebar-scrollbox >
< noscript >
< iframe class = "sidebar-iframe-outer" src = "toc.html" > < / iframe >
< / noscript >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" >
< div class = "sidebar-resize-indicator" > < / div >
2024-07-14 20:20:42 +04:00
< / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2024-11-11 07:31:10 +04:00
< div id = "menu-bar-hover-placeholder" > < / div >
2024-07-14 20:20:42 +04:00
< div id = "menu-bar" class = "menu-bar sticky" >
< div class = "left-buttons" >
< label id = "sidebar-toggle" class = "icon-button" for = "sidebar-toggle-anchor" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / label >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "colibri" > Colibri< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > < / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< a href = "https://github.com/helix-editor/helix" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< a href = "https://github.com/helix-editor/helix/edit/master/book/src/usage.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
< h1 id = "using-helix" > < a class = "header" href = "#using-helix" > Using Helix< / a > < / h1 >
< p > For a full interactive introduction to Helix, refer to the
< a href = "https://github.com/helix-editor/helix/blob/master/runtime/tutor" > tutor< / a > which
can be accessed via the command < code > hx --tutor< / code > or < code > :tutor< / code > .< / p >
< blockquote >
< p > 💡 Currently, not all functionality is fully documented, please refer to the
< a href = "./keymap.html" > key mappings< / a > list.< / p >
< / blockquote >
2024-09-30 06:19:18 +04:00
< h2 id = "modes" > < a class = "header" href = "#modes" > Modes< / a > < / h2 >
< p > Helix is a modal editor, meaning it has different modes for different tasks. The main modes are:< / p >
< ul >
< li > < a href = "./keymap.html#normal-mode" > Normal mode< / a > : For navigation and editing commands. This is the default mode.< / li >
< li > < a href = "./keymap.html#insert-mode" > Insert mode< / a > : For typing text directly into the document. Access by typing < code > i< / code > in normal mode.< / li >
< li > < a href = "./keymap.html#select--extend-mode" > Select/extend mode< / a > : For making selections and performing operations on them. Access by typing < code > v< / code > in normal mode.< / li >
< / ul >
< h2 id = "buffers" > < a class = "header" href = "#buffers" > Buffers< / a > < / h2 >
< p > Buffers are in-memory representations of files. You can have multiple buffers open at once. Use < a href = "./pickers.html" > pickers< / a > or commands like < code > :buffer-next< / code > and < code > :buffer-previous< / code > to open buffers or switch between them.< / p >
< h2 id = "selection-first-editing" > < a class = "header" href = "#selection-first-editing" > Selection-first editing< / a > < / h2 >
< p > Inspired by < a href = "http://kakoune.org/" > Kakoune< / a > , Helix follows the < code > selection → action< / code > model. This means that whatever you are going to act on (a word, a paragraph, a line, etc.) is selected first and the action itself (delete, change, yank, etc.) comes second. A cursor is simply a single width selection.< / p >
< h2 id = "multiple-selections" > < a class = "header" href = "#multiple-selections" > Multiple selections< / a > < / h2 >
< p > Also inspired by Kakoune, multiple selections are a core mode of interaction in Helix. For example, the standard way of replacing multiple instance of a word is to first select all instances (so there is one selection per instance) and then use the change action (< code > c< / code > ) to edit them all at the same time.< / p >
< h2 id = "motions" > < a class = "header" href = "#motions" > Motions< / a > < / h2 >
< p > Motions are commands that move the cursor or modify selections. They're used for navigation and text manipulation. Examples include < code > w< / code > to move to the next word, or < code > f< / code > to find a character. See the < a href = "./keymap.html#movement" > Movement< / a > section of the keymap for more motions.< / p >
2024-07-14 20:20:42 +04:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "building-from-source.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next prefetch" href = "registers.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "building-from-source.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next prefetch" href = "registers.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" > < / script >
< script src = "mark.min.js" > < / script >
< script src = "searcher.js" > < / script >
< script src = "clipboard.min.js" > < / script >
< script src = "highlight.js" > < / script >
< script src = "book.js" > < / script >
<!-- Custom JS scripts -->
< / div >
< / body >
< / html >
