diff options
Diffstat (limited to 'configuration.html')
| -rw-r--r-- | configuration.html | 166 |
1 files changed, 101 insertions, 65 deletions
diff --git a/configuration.html b/configuration.html index 611e69f9..b55414a4 100644 --- a/configuration.html +++ b/configuration.html @@ -189,16 +189,16 @@ <p>π‘ You can easily open the config file by typing <code>:config-open</code> within Helix normal mode.</p> </blockquote> <p>Example config:</p> -<pre><code class="language-toml">theme = "onedark" +<pre><code class="language-toml">theme = "onedark" [editor] -line-number = "relative" +line-number = "relative" mouse = false [editor.cursor-shape] -insert = "bar" -normal = "block" -select = "underline" +insert = "bar" +normal = "block" +select = "underline" [editor.file-picker] hidden = false @@ -216,15 +216,16 @@ Its settings will be merged with the configuration directory <code>config.toml</ <tr><td><code>mouse</code></td><td>Enable mouse mode</td><td><code>true</code></td></tr> <tr><td><code>middle-click-paste</code></td><td>Middle click paste support</td><td><code>true</code></td></tr> <tr><td><code>scroll-lines</code></td><td>Number of lines to scroll per scroll wheel step</td><td><code>3</code></td></tr> -<tr><td><code>shell</code></td><td>Shell to use when running external commands</td><td>Unix: <code>["sh", "-c"]</code><br/>Windows: <code>["cmd", "/C"]</code></td></tr> +<tr><td><code>shell</code></td><td>Shell to use when running external commands</td><td>Unix: <code>["sh", "-c"]</code><br/>Windows: <code>["cmd", "/C"]</code></td></tr> <tr><td><code>line-number</code></td><td>Line number display: <code>absolute</code> simply shows each line's number, while <code>relative</code> shows the distance from the current line. When unfocused or in insert mode, <code>relative</code> will still show absolute line numbers</td><td><code>absolute</code></td></tr> <tr><td><code>cursorline</code></td><td>Highlight all lines with a cursor</td><td><code>false</code></td></tr> <tr><td><code>cursorcolumn</code></td><td>Highlight all columns with a cursor</td><td><code>false</code></td></tr> -<tr><td><code>gutters</code></td><td>Gutters to display: Available are <code>diagnostics</code> and <code>diff</code> and <code>line-numbers</code> and <code>spacer</code>, note that <code>diagnostics</code> also includes other features like breakpoints, 1-width padding will be inserted if gutters is non-empty</td><td><code>["diagnostics", "spacer", "line-numbers", "spacer", "diff"]</code></td></tr> +<tr><td><code>gutters</code></td><td>Gutters to display: Available are <code>diagnostics</code> and <code>diff</code> and <code>line-numbers</code> and <code>spacer</code>, note that <code>diagnostics</code> also includes other features like breakpoints, 1-width padding will be inserted if gutters is non-empty</td><td><code>["diagnostics", "spacer", "line-numbers", "spacer", "diff"]</code></td></tr> <tr><td><code>auto-completion</code></td><td>Enable automatic pop up of auto-completion</td><td><code>true</code></td></tr> <tr><td><code>auto-format</code></td><td>Enable automatic formatting on save</td><td><code>true</code></td></tr> <tr><td><code>auto-save</code></td><td>Enable automatic saving on the focus moving away from Helix. Requires <a href="https://github.com/helix-editor/helix/wiki/Terminal-Support">focus event support</a> from your terminal</td><td><code>false</code></td></tr> -<tr><td><code>idle-timeout</code></td><td>Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant</td><td><code>400</code></td></tr> +<tr><td><code>idle-timeout</code></td><td>Time in milliseconds since last keypress before idle timers trigger.</td><td><code>250</code></td></tr> +<tr><td><code>completion-timeout</code></td><td>Time in milliseconds after typing a word character before completions are shown, set to 5 for instant.</td><td><code>250</code></td></tr> <tr><td><code>preview-completion-insert</code></td><td>Whether to apply completion item instantly when selected</td><td><code>true</code></td></tr> <tr><td><code>completion-trigger-len</code></td><td>The min-length of word under cursor to trigger autocompletion</td><td><code>2</code></td></tr> <tr><td><code>completion-replace</code></td><td>Set to <code>true</code> to make completions always replace the entire word and not just the part before the cursor</td><td><code>false</code></td></tr> @@ -233,38 +234,41 @@ Its settings will be merged with the configuration directory <code>config.toml</ <tr><td><code>undercurl</code></td><td>Set to <code>true</code> to override automatic detection of terminal undercurl support in the event of a false negative</td><td><code>false</code></td></tr> <tr><td><code>rulers</code></td><td>List of column positions at which to display the rulers. Can be overridden by language specific <code>rulers</code> in <code>languages.toml</code> file</td><td><code>[]</code></td></tr> <tr><td><code>bufferline</code></td><td>Renders a line at the top of the editor displaying open buffers. Can be <code>always</code>, <code>never</code> or <code>multiple</code> (only shown if more than one buffer is in use)</td><td><code>never</code></td></tr> -<tr><td><code>initial-mode</code></td><td>The initial mode for newly opened editors.</td><td><code>"normal"</code></td></tr> <tr><td><code>color-modes</code></td><td>Whether to color the mode indicator with different colors depending on the mode itself</td><td><code>false</code></td></tr> <tr><td><code>text-width</code></td><td>Maximum line length. Used for the <code>:reflow</code> command and soft-wrapping if <code>soft-wrap.wrap-at-text-width</code> is set</td><td><code>80</code></td></tr> <tr><td><code>workspace-lsp-roots</code></td><td>Directories relative to the workspace root that are treated as LSP roots. Should only be set in <code>.helix/config.toml</code></td><td><code>[]</code></td></tr> <tr><td><code>default-line-ending</code></td><td>The line ending to use for new documents. Can be <code>native</code>, <code>lf</code>, <code>crlf</code>, <code>ff</code>, <code>cr</code> or <code>nel</code>. <code>native</code> uses the platform's native line ending (<code>crlf</code> on Windows, otherwise <code>lf</code>).</td><td><code>native</code></td></tr> <tr><td><code>insert-final-newline</code></td><td>Whether to automatically insert a trailing line-ending on write if missing</td><td><code>true</code></td></tr> +<tr><td><code>popup-border</code></td><td>Draw border around <code>popup</code>, <code>menu</code>, <code>all</code>, or <code>none</code></td><td><code>none</code></td></tr> +<tr><td><code>indent-heuristic</code></td><td>How the indentation for a newly inserted line is computed: <code>simple</code> just copies the indentation level from the previous line, <code>tree-sitter</code> computes the indentation based on the syntax tree and <code>hybrid</code> combines both approaches. If the chosen heuristic is not available, a different one will be used as a fallback (the fallback order being <code>hybrid</code> -> <code>tree-sitter</code> -> <code>simple</code>).</td><td><code>hybrid</code></td></tr> +<tr><td><code>jump-label-alphabet</code></td><td>The characters that are used to generate two character jump labels. Characters at the start of the alphabet are used first.</td><td><code>"abcdefghijklmnopqrstuvwxyz"</code></td></tr> +<tr><td><code>initial-mode</code></td><td>The initial mode for newly opened editors.</td><td><code>"normal"</code></td></tr> <tr><td><code>rainbow-brackets</code></td><td>Whether to render rainbow colors for matching brackets. Requires tree-sitter <code>rainbows.scm</code> queries for the language.</td><td><code>false</code></td></tr> </tbody></table> </div> <h3 id="editorstatusline-section"><a class="header" href="#editorstatusline-section"><code>[editor.statusline]</code> Section</a></h3> <p>Allows configuring the statusline at the bottom of the editor.</p> <p>The configuration distinguishes between three areas of the status line:</p> -<p><code>[ ... ... LEFT ... ... | ... ... ... ... CENTER ... ... ... ... | ... ... RIGHT ... ... ]</code></p> +<p><code>[ ... ... LEFT ... ... | ... ... ... CENTER ... ... ... | ... ... RIGHT ... ... ]</code></p> <p>Statusline elements can be defined as follows:</p> <pre><code class="language-toml">[editor.statusline] -left = ["mode", "spinner"] -center = ["file-name"] -right = ["diagnostics", "selections", "position", "file-encoding", "file-line-ending", "file-type"] -separator = "β" -mode.normal = "NORMAL" -mode.insert = "INSERT" -mode.select = "SELECT" +left = ["mode", "spinner"] +center = ["file-name"] +right = ["diagnostics", "selections", "position", "file-encoding", "file-line-ending", "file-type"] +separator = "β" +mode.normal = "NORMAL" +mode.insert = "INSERT" +mode.select = "SELECT" </code></pre> <p>The <code>[editor.statusline]</code> key takes the following sub-keys:</p> <div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody> -<tr><td><code>left</code></td><td>A list of elements aligned to the left of the statusline</td><td><code>["mode", "spinner", "file-name", "read-only-indicator", "file-modification-indicator"]</code></td></tr> +<tr><td><code>left</code></td><td>A list of elements aligned to the left of the statusline</td><td><code>["mode", "spinner", "file-name", "read-only-indicator", "file-modification-indicator"]</code></td></tr> <tr><td><code>center</code></td><td>A list of elements aligned to the middle of the statusline</td><td><code>[]</code></td></tr> -<tr><td><code>right</code></td><td>A list of elements aligned to the right of the statusline</td><td><code>["diagnostics", "selections", "register", "position", "file-encoding"]</code></td></tr> -<tr><td><code>separator</code></td><td>The character used to separate elements in the statusline</td><td><code>"β"</code></td></tr> -<tr><td><code>mode.normal</code></td><td>The text shown in the <code>mode</code> element for normal mode</td><td><code>"NOR"</code></td></tr> -<tr><td><code>mode.insert</code></td><td>The text shown in the <code>mode</code> element for insert mode</td><td><code>"INS"</code></td></tr> -<tr><td><code>mode.select</code></td><td>The text shown in the <code>mode</code> element for select mode</td><td><code>"SEL"</code></td></tr> +<tr><td><code>right</code></td><td>A list of elements aligned to the right of the statusline</td><td><code>["diagnostics", "selections", "register", "position", "file-encoding"]</code></td></tr> +<tr><td><code>separator</code></td><td>The character used to separate elements in the statusline</td><td><code>"β"</code></td></tr> +<tr><td><code>mode.normal</code></td><td>The text shown in the <code>mode</code> element for normal mode</td><td><code>"NOR"</code></td></tr> +<tr><td><code>mode.insert</code></td><td>The text shown in the <code>mode</code> element for insert mode</td><td><code>"INS"</code></td></tr> +<tr><td><code>mode.select</code></td><td>The text shown in the <code>mode</code> element for select mode</td><td><code>"SEL"</code></td></tr> </tbody></table> </div> <p>The following statusline elements can be configured:</p> @@ -272,6 +276,7 @@ mode.select = "SELECT" <tr><td><code>mode</code></td><td>The current editor mode (<code>mode.normal</code>/<code>mode.insert</code>/<code>mode.select</code>)</td></tr> <tr><td><code>spinner</code></td><td>A progress spinner indicating LSP activity</td></tr> <tr><td><code>file-name</code></td><td>The path/name of the opened file</td></tr> +<tr><td><code>file-absolute-path</code></td><td>The absolute path/name of the opened file</td></tr> <tr><td><code>file-base-name</code></td><td>The basename of the opened file</td></tr> <tr><td><code>file-modification-indicator</code></td><td>The indicator to show whether the file is modified (a <code>[+]</code> appears when there are unsaved changes)</td></tr> <tr><td><code>file-encoding</code></td><td>The encoding of the opened file if it differs from UTF-8</td></tr> @@ -285,7 +290,7 @@ mode.select = "SELECT" <tr><td><code>primary-selection-length</code></td><td>The number of characters currently in primary selection</td></tr> <tr><td><code>position</code></td><td>The cursor position</td></tr> <tr><td><code>position-percentage</code></td><td>The cursor position as a percentage of the total number of lines</td></tr> -<tr><td><code>separator</code></td><td>The string defined in <code>editor.statusline.separator</code> (defaults to <code>"β"</code>)</td></tr> +<tr><td><code>separator</code></td><td>The string defined in <code>editor.statusline.separator</code> (defaults to <code>"β"</code>)</td></tr> <tr><td><code>spacer</code></td><td>Inserts a space between elements (multiple/contiguous spacers may be specified)</td></tr> <tr><td><code>version-control</code></td><td>The current branch name or detached commit hash of the opened workspace</td></tr> <tr><td><code>register</code></td><td>The current selected register</td></tr> @@ -326,17 +331,29 @@ change shape.</p> not visible in the Helix file picker and global search.</p> <p>All git related options are only enabled in a git repository.</p> <div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody> -<tr><td><code>hidden</code></td><td>Enables ignoring hidden files</td><td>true</td></tr> -<tr><td><code>follow-symlinks</code></td><td>Follow symlinks instead of ignoring them</td><td>true</td></tr> -<tr><td><code>deduplicate-links</code></td><td>Ignore symlinks that point at files already shown in the picker</td><td>true</td></tr> -<tr><td><code>parents</code></td><td>Enables reading ignore files from parent directories</td><td>true</td></tr> -<tr><td><code>ignore</code></td><td>Enables reading <code>.ignore</code> files</td><td>true</td></tr> -<tr><td><code>git-ignore</code></td><td>Enables reading <code>.gitignore</code> files</td><td>true</td></tr> -<tr><td><code>git-global</code></td><td>Enables reading global <code>.gitignore</code>, whose path is specified in git's config: <code>core.excludefile</code> option</td><td>true</td></tr> -<tr><td><code>git-exclude</code></td><td>Enables reading <code>.git/info/exclude</code> files</td><td>true</td></tr> -<tr><td><code>max-depth</code></td><td>Set with an integer value for maximum depth to recurse</td><td>Defaults to <code>None</code>.</td></tr> +<tr><td><code>hidden</code></td><td>Enables ignoring hidden files</td><td><code>true</code></td></tr> +<tr><td><code>follow-symlinks</code></td><td>Follow symlinks instead of ignoring them</td><td><code>true</code></td></tr> +<tr><td><code>deduplicate-links</code></td><td>Ignore symlinks that point at files already shown in the picker</td><td><code>true</code></td></tr> +<tr><td><code>parents</code></td><td>Enables reading ignore files from parent directories</td><td><code>true</code></td></tr> +<tr><td><code>ignore</code></td><td>Enables reading <code>.ignore</code> files</td><td><code>true</code></td></tr> +<tr><td><code>git-ignore</code></td><td>Enables reading <code>.gitignore</code> files</td><td><code>true</code></td></tr> +<tr><td><code>git-global</code></td><td>Enables reading global <code>.gitignore</code>, whose path is specified in git's config: <code>core.excludesfile</code> option</td><td><code>true</code></td></tr> +<tr><td><code>git-exclude</code></td><td>Enables reading <code>.git/info/exclude</code> files</td><td><code>true</code></td></tr> +<tr><td><code>max-depth</code></td><td>Set with an integer value for maximum depth to recurse</td><td>Unset by default</td></tr> </tbody></table> </div> +<p>Ignore files can be placed locally as <code>.ignore</code> or put in your home directory as <code>~/.ignore</code>. They support the usual ignore and negative ignore (unignore) rules used in <code>.gitignore</code> files.</p> +<p>Additionally, you can use Helix-specific ignore files by creating a local <code>.helix/ignore</code> file in the current workspace or a global <code>ignore</code> file located in your Helix config directory:</p> +<ul> +<li>Linux and Mac: <code>~/.config/helix/ignore</code></li> +<li>Windows: <code>%AppData%\helix\ignore</code></li> +</ul> +<p>Example:</p> +<pre><code class="language-ini"># unignore in file picker and global search +!.github/ +!.gitignore +!.gitattributes +</code></pre> <h3 id="editorauto-pairs-section"><a class="header" href="#editorauto-pairs-section"><code>[editor.auto-pairs]</code> Section</a></h3> <p>Enables automatic insertion of pairs to parentheses, brackets, etc. Can be a simple boolean value, or a specific mapping of pairs of single characters.</p> @@ -344,28 +361,28 @@ simple boolean value, or a specific mapping of pairs of single characters.</p> <pre><code class="language-toml">[editor] auto-pairs = false # defaults to `true` </code></pre> -<p>The default pairs are <code>(){}[]''""``</code>, but these can be customized by +<p>The default pairs are <code>(){}[]''""``</code>, but these can be customized by setting <code>auto-pairs</code> to a TOML table:</p> <pre><code class="language-toml">[editor.auto-pairs] '(' = ')' '{' = '}' '[' = ']' -'"' = '"' +'"' = '"' '`' = '`' '<' = '>' </code></pre> <p>Additionally, this setting can be used in a language config. Unless the editor setting is <code>false</code>, this will override the editor config in documents with this language.</p> -<p>Example <code>languages.toml</code> that adds <> and removes ''</p> +<p>Example <code>languages.toml</code> that adds <code><></code> and removes <code>''</code></p> <pre><code class="language-toml">[[language]] -name = "rust" +name = "rust" [language.auto-pairs] '(' = ')' '{' = '}' '[' = ']' -'"' = '"' +'"' = '"' '`' = '`' '<' = '>' </code></pre> @@ -379,25 +396,28 @@ name = "rust" <h3 id="editorwhitespace-section"><a class="header" href="#editorwhitespace-section"><code>[editor.whitespace]</code> Section</a></h3> <p>Options for rendering whitespace with visible characters. Use <code>:set whitespace.render all</code> to temporarily enable visible whitespace.</p> <div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody> -<tr><td><code>render</code></td><td>Whether to render whitespace. May either be <code>"all"</code> or <code>"none"</code>, or a table with sub-keys <code>space</code>, <code>nbsp</code>, <code>tab</code>, and <code>newline</code></td><td><code>"none"</code></td></tr> -<tr><td><code>characters</code></td><td>Literal characters to use when rendering whitespace. Sub-keys may be any of <code>tab</code>, <code>space</code>, <code>nbsp</code>, <code>newline</code> or <code>tabpad</code></td><td>See example below</td></tr> +<tr><td><code>render</code></td><td>Whether to render whitespace. May either be <code>all</code> or <code>none</code>, or a table with sub-keys <code>space</code>, <code>nbsp</code>, <code>nnbsp</code>, <code>tab</code>, and <code>newline</code></td><td><code>none</code></td></tr> +<tr><td><code>characters</code></td><td>Literal characters to use when rendering whitespace. Sub-keys may be any of <code>tab</code>, <code>space</code>, <code>nbsp</code>, <code>nnbsp</code>, <code>newline</code> or <code>tabpad</code></td><td>See example below</td></tr> </tbody></table> </div> <p>Example</p> <pre><code class="language-toml">[editor.whitespace] -render = "all" +render = "all" # or control each character [editor.whitespace.render] -space = "all" -tab = "all" -newline = "none" +space = "all" +tab = "all" +nbsp = "none" +nnbsp = "none" +newline = "none" [editor.whitespace.characters] -space = "Β·" -nbsp = "β½" -tab = "β" -newline = "β" -tabpad = "Β·" # Tabs will look like "βΒ·Β·Β·" (depending on tab width) +space = "Β·" +nbsp = "β½" +nnbsp = "β£" +tab = "β" +newline = "β" +tabpad = "Β·" # Tabs will look like "βΒ·Β·Β·" (depending on tab width) </code></pre> <h3 id="editorindent-guides-section"><a class="header" href="#editorindent-guides-section"><code>[editor.indent-guides]</code> Section</a></h3> <p>Options for rendering vertical indent guides.</p> @@ -411,26 +431,26 @@ tabpad = "Β·" # Tabs will look like "βΒ·Β·Β·" (depending o <p>Example:</p> <pre><code class="language-toml">[editor.indent-guides] render = true -character = "β" # Some characters that work well: "β", "β", "β", "βΈ½" +character = "β" # Some characters that work well: "β", "β", "β", "βΈ½" skip-levels = 1 -rainbow-option = "normal" +rainbow-option = "normal" </code></pre> <h3 id="editorgutters-section"><a class="header" href="#editorgutters-section"><code>[editor.gutters]</code> Section</a></h3> <p>For simplicity, <code>editor.gutters</code> accepts an array of gutter types, which will use default settings for all gutter components.</p> <pre><code class="language-toml">[editor] -gutters = ["diff", "diagnostics", "line-numbers", "spacer"] +gutters = ["diff", "diagnostics", "line-numbers", "spacer"] </code></pre> <p>To customize the behavior of gutters, the <code>[editor.gutters]</code> section must be used. This section contains top level settings, as well as settings for specific gutter components as subsections.</p> <div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody> -<tr><td><code>layout</code></td><td>A vector of gutters to display</td><td><code>["diagnostics", "spacer", "line-numbers", "spacer", "diff"]</code></td></tr> +<tr><td><code>layout</code></td><td>A vector of gutters to display</td><td><code>["diagnostics", "spacer", "line-numbers", "spacer", "diff"]</code></td></tr> </tbody></table> </div> <p>Example:</p> <pre><code class="language-toml">[editor.gutters] -layout = ["diff", "diagnostics", "line-numbers", "spacer"] +layout = ["diff", "diagnostics", "line-numbers", "spacer"] </code></pre> <h4 id="editorguttersline-numbers-section"><a class="header" href="#editorguttersline-numbers-section"><code>[editor.gutters.line-numbers]</code> Section</a></h4> <p>Options for the line number gutter</p> @@ -445,7 +465,10 @@ min-width = 1 <h4 id="editorguttersdiagnostics-section"><a class="header" href="#editorguttersdiagnostics-section"><code>[editor.gutters.diagnostics]</code> Section</a></h4> <p>Currently unused</p> <h4 id="editorguttersdiff-section"><a class="header" href="#editorguttersdiff-section"><code>[editor.gutters.diff]</code> Section</a></h4> -<p>Currently unused</p> +<p>The <code>diff</code> gutter option displays colored bars indicating whether a <code>git</code> diff represents that a line was added, removed or changed. +These colors are controlled by the theme attributes <code>diff.plus</code>, <code>diff.minus</code> and <code>diff.delta</code>.</p> +<p>Other diff providers will eventually be supported by a future plugin system.</p> +<p>There are currently no options for this section.</p> <h4 id="editorguttersspacer-section"><a class="header" href="#editorguttersspacer-section"><code>[editor.gutters.spacer]</code> Section</a></h4> <p>Currently unused</p> <h3 id="editorsoft-wrap-section"><a class="header" href="#editorsoft-wrap-section"><code>[editor.soft-wrap]</code> Section</a></h3> @@ -463,7 +486,26 @@ min-width = 1 enable = true max-wrap = 25 # increase value to reduce forced mid-word wrapping max-indent-retain = 0 -wrap-indicator = "" # set wrap-indicator to "" to hide it +wrap-indicator = "" # set wrap-indicator to "" to hide it +</code></pre> +<h3 id="editorsmart-tab-section"><a class="header" href="#editorsmart-tab-section"><code>[editor.smart-tab]</code> Section</a></h3> +<p>Options for navigating and editing using tab key.</p> +<div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody> +<tr><td><code>enable</code></td><td>If set to true, then when the cursor is in a position with non-whitespace to its left, instead of inserting a tab, it will run <code>move_parent_node_end</code>. If there is only whitespace to the left, then it inserts a tab as normal. With the default bindings, to explicitly insert a tab character, press Shift-tab.</td><td><code>true</code></td></tr> +<tr><td><code>supersede-menu</code></td><td>Normally, when a menu is on screen, such as when auto complete is triggered, the tab key is bound to cycling through the items. This means when menus are on screen, one cannot use the tab key to trigger the <code>smart-tab</code> command. If this option is set to true, the <code>smart-tab</code> command always takes precedence, which means one cannot use the tab key to cycle through menu items. One of the other bindings must be used instead, such as arrow keys or <code>C-n</code>/<code>C-p</code>.</td><td><code>false</code></td></tr> +</tbody></table> +</div> +<p>Due to lack of support for S-tab in some terminals, the default keybindings don't fully embrace smart-tab editing experience. If you enjoy smart-tab navigation and a terminal that supports the <a href="https://github.com/helix-editor/helix/wiki/Terminal-Support#enhanced-keyboard-protocol">Enhanced Keyboard protocol</a>, consider setting extra keybindings:</p> +<pre><code>[keys.normal] +tab = "move_parent_node_end" +S-tab = "move_parent_node_start" + +[keys.insert] +S-tab = "move_parent_node_start" + +[keys.select] +tab = "extend_parent_node_end" +S-tab = "extend_parent_node_start" </code></pre> <h3 id="editorexplorer-section"><a class="header" href="#editorexplorer-section"><code>[editor.explorer]</code> Section</a></h3> <p>Sets explorer side width and style.</p> @@ -472,19 +514,13 @@ wrap-indicator = "" # set wrap-indicator to "" to hide it <tr><td><code>position</code></td><td>explorer widget position, <code>left</code> or <code>right</code></td><td><code>left</code></td></tr> </tbody></table> </div> -<h3 id="editorsmart-tab-section"><a class="header" href="#editorsmart-tab-section"><code>[editor.smart-tab]</code> Section</a></h3> -<div class="table-wrapper"><table><thead><tr><th>Key</th><th>Description</th><th>Default</th></tr></thead><tbody> -<tr><td><code>enable</code></td><td>If set to true, then when the cursor is in a position with non-whitespace to its left, instead of inserting a tab, it will run <code>move_parent_node_end</code>. If there is only whitespace to the left, then it inserts a tab as normal. With the default bindings, to explicitly insert a tab character, press Shift-tab.</td><td><code>true</code></td></tr> -<tr><td><code>supersede-menu</code></td><td>Normally, when a menu is on screen, such as when auto complete is triggered, the tab key is bound to cycling through the items. This means when menus are on screen, one cannot use the tab key to trigger the <code>smart-tab</code> command. If this option is set to true, the <code>smart-tab</code> command always takes precedence, which means one cannot use the tab key to cycle through menu items. One of the other bindings must be used instead, such as arrow keys or <code>C-n</code>/<code>C-p</code>.</td><td><code>false</code></td></tr> -</tbody></table> -</div> <h3 id="editordigraphs-section"><a class="header" href="#editordigraphs-section"><code>[editor.digraphs]</code> Section</a></h3> <p>By default, special characters can be input using the <code>insert_digraphs</code> command, bound to <code>\</code> in normal mode. Custom digraphs can be added to the <code>editor.digraphs</code> section of the config.</p> <pre><code class="language-toml">[editor.digraphs] -ka = "γ" -ku = { symbols = "γ", description = "The japanese character Ku" } -shrug = "Β―\\_(γ)_/Β―" +ka = "γ" +ku = { symbols = "γ", description = "The japanese character Ku" } +shrug = "Β―\\_(γ)_/Β―" </code></pre> </main> |