mirror of https://github.com/helix-editor/helix
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
366 lines
21 KiB
HTML
366 lines
21 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Keymap</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<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="preconnect" href="https://fonts.gstatic.com">
|
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@200;400;500;700&display=swap" rel="stylesheet">
|
|
<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 -->
|
|
|
|
</head>
|
|
<body>
|
|
<!-- Provide site root to javascript -->
|
|
<script type="text/javascript">
|
|
var path_to_root = "";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script type="text/javascript">
|
|
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 type="text/javascript">
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('no-js')
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add('js');
|
|
</script>
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script type="text/javascript">
|
|
var html = document.querySelector('html');
|
|
var sidebar = 'hidden';
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
}
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded "><a href="install.html"><strong aria-hidden="true">1.</strong> Installation</a></li><li class="chapter-item expanded "><a href="usage.html"><strong aria-hidden="true">2.</strong> Usage</a></li><li class="chapter-item expanded "><a href="configuration.html"><strong aria-hidden="true">3.</strong> Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="themes.html"><strong aria-hidden="true">3.1.</strong> Themes</a></li><li class="chapter-item expanded "><a href="keymap.html" class="active"><strong aria-hidden="true">3.2.</strong> Keymap</a></li><li class="chapter-item expanded "><a href="remapping.html"><strong aria-hidden="true">3.3.</strong> Key Remapping</a></li><li class="chapter-item expanded "><a href="hooks.html"><strong aria-hidden="true">3.4.</strong> Hooks</a></li></ol></li></ol> </div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
|
<div class="left-buttons">
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</button>
|
|
<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 (default)</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>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" name="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 type="text/javascript">
|
|
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="keymap"><a class="header" href="#keymap">Keymap</a></h1>
|
|
<h2 id="normal-mode"><a class="header" href="#normal-mode">Normal mode</a></h2>
|
|
<h3 id="movement"><a class="header" href="#movement">Movement</a></h3>
|
|
<blockquote>
|
|
<p>NOTE: <code>f</code>, <code>F</code>, <code>t</code> and <code>T</code> are not confined to the current line.</p>
|
|
</blockquote>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>h</code>, <code>Left</code></td><td>Move left</td></tr>
|
|
<tr><td><code>j</code>, <code>Down</code></td><td>Move down</td></tr>
|
|
<tr><td><code>k</code>, <code>Up</code></td><td>Move up</td></tr>
|
|
<tr><td><code>l</code>, <code>Right</code></td><td>Move right</td></tr>
|
|
<tr><td><code>w</code></td><td>Move next word start</td></tr>
|
|
<tr><td><code>b</code></td><td>Move previous word start</td></tr>
|
|
<tr><td><code>e</code></td><td>Move next word end</td></tr>
|
|
<tr><td><code>t</code></td><td>Find 'till next char</td></tr>
|
|
<tr><td><code>f</code></td><td>Find next char</td></tr>
|
|
<tr><td><code>T</code></td><td>Find 'till previous char</td></tr>
|
|
<tr><td><code>F</code></td><td>Find previous char</td></tr>
|
|
<tr><td><code>Home</code></td><td>Move to the start of the line</td></tr>
|
|
<tr><td><code>End</code></td><td>Move to the end of the line</td></tr>
|
|
<tr><td><code>m</code></td><td>Jump to matching bracket</td></tr>
|
|
<tr><td><code>PageUp</code></td><td>Move page up</td></tr>
|
|
<tr><td><code>PageDown</code></td><td>Move page down</td></tr>
|
|
<tr><td><code>Ctrl-u</code></td><td>Move half page up</td></tr>
|
|
<tr><td><code>Ctrl-d</code></td><td>Move half page down</td></tr>
|
|
<tr><td><code>Ctrl-i</code></td><td>Jump forward on the jumplist TODO: conflicts tab</td></tr>
|
|
<tr><td><code>Ctrl-o</code></td><td>Jump backward on the jumplist</td></tr>
|
|
<tr><td><code>v</code></td><td>Enter <a href="#select--extend-mode">select (extend) mode</a></td></tr>
|
|
<tr><td><code>g</code></td><td>Enter <a href="#goto-mode">goto mode</a></td></tr>
|
|
<tr><td><code>:</code></td><td>Enter command mode</td></tr>
|
|
<tr><td><code>z</code></td><td>Enter <a href="#view-mode">view mode</a></td></tr>
|
|
<tr><td><code>Ctrl-w</code></td><td>Enter <a href="#window-mode">window mode</a> (maybe will be remove for spc w w later)</td></tr>
|
|
<tr><td><code>Space</code></td><td>Enter <a href="#space-mode">space mode</a></td></tr>
|
|
<tr><td><code>K</code></td><td>Show documentation for the item under the cursor</td></tr>
|
|
</tbody></table>
|
|
<h3 id="changes"><a class="header" href="#changes">Changes</a></h3>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>r</code></td><td>Replace with a character</td></tr>
|
|
<tr><td><code>R</code></td><td>Replace with yanked text</td></tr>
|
|
<tr><td><code>i</code></td><td>Insert before selection</td></tr>
|
|
<tr><td><code>a</code></td><td>Insert after selection (append)</td></tr>
|
|
<tr><td><code>I</code></td><td>Insert at the start of the line</td></tr>
|
|
<tr><td><code>A</code></td><td>Insert at the end of the line</td></tr>
|
|
<tr><td><code>o</code></td><td>Open new line below selection</td></tr>
|
|
<tr><td><code>o</code></td><td>Open new line above selection</td></tr>
|
|
<tr><td><code>u</code></td><td>Undo change</td></tr>
|
|
<tr><td><code>U</code></td><td>Redo change</td></tr>
|
|
<tr><td><code>y</code></td><td>Yank selection</td></tr>
|
|
<tr><td><code>p</code></td><td>Paste after selection</td></tr>
|
|
<tr><td><code>P</code></td><td>Paste before selection</td></tr>
|
|
<tr><td><code>></code></td><td>Indent selection</td></tr>
|
|
<tr><td><code><</code></td><td>Unindent selection</td></tr>
|
|
<tr><td><code>=</code></td><td>Format selection</td></tr>
|
|
<tr><td><code>d</code></td><td>Delete selection</td></tr>
|
|
<tr><td><code>c</code></td><td>Change selection (delete and enter insert mode)</td></tr>
|
|
</tbody></table>
|
|
<h3 id="selection-manipulation"><a class="header" href="#selection-manipulation">Selection manipulation</a></h3>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>s</code></td><td>Select all regex matches inside selections</td></tr>
|
|
<tr><td><code>S</code></td><td>Split selection into subselections on regex matches</td></tr>
|
|
<tr><td><code>Alt-s</code></td><td>Split selection on newlines</td></tr>
|
|
<tr><td><code>;</code></td><td>Collapse selection onto a single cursor</td></tr>
|
|
<tr><td><code>Alt-;</code></td><td>Flip selection cursor and anchor</td></tr>
|
|
<tr><td><code>%</code></td><td>Select entire file</td></tr>
|
|
<tr><td><code>x</code></td><td>Select current line</td></tr>
|
|
<tr><td><code>X</code></td><td>Extend to next line</td></tr>
|
|
<tr><td><code>[</code></td><td>Expand selection to parent syntax node TODO: pick a key</td></tr>
|
|
<tr><td><code>J</code></td><td>join lines inside selection</td></tr>
|
|
<tr><td><code>K</code></td><td>keep selections matching the regex TODO: overlapped by hover help</td></tr>
|
|
<tr><td><code>Space</code></td><td>keep only the primary selection TODO: overlapped by space mode</td></tr>
|
|
<tr><td><code>Ctrl-c</code></td><td>Comment/uncomment the selections</td></tr>
|
|
</tbody></table>
|
|
<h3 id="search"><a class="header" href="#search">Search</a></h3>
|
|
<blockquote>
|
|
<p>TODO: The search implementation isn't ideal yet -- we don't support searching
|
|
in reverse, or searching via smartcase.</p>
|
|
</blockquote>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>/</code></td><td>Search for regex pattern</td></tr>
|
|
<tr><td><code>n</code></td><td>Select next search match</td></tr>
|
|
<tr><td><code>N</code></td><td>Add next search match to selection</td></tr>
|
|
<tr><td><code>*</code></td><td>Use current selection as the search pattern</td></tr>
|
|
</tbody></table>
|
|
<h3 id="diagnostics"><a class="header" href="#diagnostics">Diagnostics</a></h3>
|
|
<blockquote>
|
|
<p>NOTE: <code>[</code> and <code>]</code> will likely contain more pair mappings in the style of
|
|
<a href="https://github.com/tpope/vim-unimpaired">vim-unimpaired</a></p>
|
|
</blockquote>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>[d</code></td><td>Go to previous diagnostic</td></tr>
|
|
<tr><td><code>]d</code></td><td>Go to next diagnostic</td></tr>
|
|
<tr><td><code>[D</code></td><td>Go to first diagnostic in document</td></tr>
|
|
<tr><td><code>]D</code></td><td>Go to last diagnostic in document</td></tr>
|
|
</tbody></table>
|
|
<h2 id="select--extend-mode"><a class="header" href="#select--extend-mode">Select / extend mode</a></h2>
|
|
<p>I'm still pondering whether to keep this mode or not. It changes movement
|
|
commands to extend the existing selection instead of replacing it.</p>
|
|
<blockquote>
|
|
<p>NOTE: It's a bit confusing at the moment because extend hasn't been
|
|
implemented for all movement commands yet.</p>
|
|
</blockquote>
|
|
<h2 id="view-mode"><a class="header" href="#view-mode">View mode</a></h2>
|
|
<p>View mode is intended for scrolling and manipulating the view without changing
|
|
the selection.</p>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>z</code> , <code>c</code></td><td>Vertically center the line</td></tr>
|
|
<tr><td><code>t</code></td><td>Align the line to the top of the screen</td></tr>
|
|
<tr><td><code>b</code></td><td>Align the line to the bottom of the screen</td></tr>
|
|
<tr><td><code>m</code></td><td>Align the line to the middle of the screen (horizontally)</td></tr>
|
|
<tr><td><code>j</code></td><td>Scroll the view downwards</td></tr>
|
|
<tr><td><code>k</code></td><td>Scroll the view upwards</td></tr>
|
|
</tbody></table>
|
|
<h2 id="goto-mode"><a class="header" href="#goto-mode">Goto mode</a></h2>
|
|
<p>Jumps to various locations.</p>
|
|
<blockquote>
|
|
<p>NOTE: Some of these features are only available with the LSP present.</p>
|
|
</blockquote>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>g</code></td><td>Go to the start of the file</td></tr>
|
|
<tr><td><code>e</code></td><td>Go to the end of the file</td></tr>
|
|
<tr><td><code>h</code></td><td>Go to the start of the line</td></tr>
|
|
<tr><td><code>l</code></td><td>Go to the end of the line</td></tr>
|
|
<tr><td><code>s</code></td><td>Go to first non-whitespace character of the line</td></tr>
|
|
<tr><td><code>t</code></td><td>Go to the top of the screen</td></tr>
|
|
<tr><td><code>m</code></td><td>Go to the middle of the screen</td></tr>
|
|
<tr><td><code>b</code></td><td>Go to the bottom of the screen</td></tr>
|
|
<tr><td><code>d</code></td><td>Go to definition</td></tr>
|
|
<tr><td><code>y</code></td><td>Go to type definition</td></tr>
|
|
<tr><td><code>r</code></td><td>Go to references</td></tr>
|
|
<tr><td><code>i</code></td><td>Go to implementation</td></tr>
|
|
<tr><td><code>a</code></td><td>Go to the last accessed/alternate file</td></tr>
|
|
</tbody></table>
|
|
<h2 id="object-mode"><a class="header" href="#object-mode">Object mode</a></h2>
|
|
<p>TODO: Mappings for selecting syntax nodes (a superset of <code>[</code>).</p>
|
|
<h2 id="window-mode"><a class="header" href="#window-mode">Window mode</a></h2>
|
|
<p>This layer is similar to vim keybindings as kakoune does not support window.</p>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>w</code>, <code>Ctrl-w</code></td><td>Switch to next window</td></tr>
|
|
<tr><td><code>v</code>, <code>Ctrl-v</code></td><td>Vertical right split</td></tr>
|
|
<tr><td><code>h</code>, <code>Ctrl-h</code></td><td>Horizontal bottom split</td></tr>
|
|
<tr><td><code>q</code>, <code>Ctrl-q</code></td><td>Close current window</td></tr>
|
|
</tbody></table>
|
|
<h2 id="space-mode"><a class="header" href="#space-mode">Space mode</a></h2>
|
|
<p>This layer is a kludge of mappings I had under leader key in neovim.</p>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>f</code></td><td>Open file picker</td></tr>
|
|
<tr><td><code>b</code></td><td>Open buffer picker</td></tr>
|
|
<tr><td><code>s</code></td><td>Open symbol picker (current document)</td></tr>
|
|
<tr><td><code>w</code></td><td>Enter <a href="#window-mode">window mode</a></td></tr>
|
|
<tr><td><code>space</code></td><td>Keep primary selection TODO: it's here because space mode replaced it</td></tr>
|
|
<tr><td><code>p</code></td><td>paste system clipboard after selections</td></tr>
|
|
<tr><td><code>P</code></td><td>paste system clipboard before selections</td></tr>
|
|
<tr><td><code>y</code></td><td>join and yank selections to clipboard</td></tr>
|
|
<tr><td><code>Y</code></td><td>yank main selection to clipboard</td></tr>
|
|
<tr><td><code>R</code></td><td>replace selections by clipboard contents</td></tr>
|
|
</tbody></table>
|
|
<h1 id="picker"><a class="header" href="#picker">Picker</a></h1>
|
|
<p>Keys to use within picker.</p>
|
|
<table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody>
|
|
<tr><td><code>Up</code>, <code>Ctrl-p</code></td><td>Previous entry</td></tr>
|
|
<tr><td><code>Down</code>, <code>Ctrl-n</code></td><td>Next entry</td></tr>
|
|
<tr><td><code>Ctrl-space</code></td><td>Filter options</td></tr>
|
|
<tr><td><code>Enter</code></td><td>Open selected</td></tr>
|
|
<tr><td><code>Ctrl-h</code></td><td>Open horizontally</td></tr>
|
|
<tr><td><code>Ctrl-v</code></td><td>Open vertically</td></tr>
|
|
<tr><td><code>Escape</code>, <code>Ctrl-c</code></td><td>Close picker</td></tr>
|
|
</tbody></table>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="themes.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" href="remapping.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="themes.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" href="remapping.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 type="text/javascript">
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="mark.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="searcher.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<script src="clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="highlight.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="book.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</body>
|
|
</html>
|