<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js colibri" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Configuration< / 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 ? "colibri" : "colibri";
< / 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('colibri')
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 affix " > < a href = "title-page.html" > Helix< / a > < / li > < 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 > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "keymap.html" > < strong aria-hidden = "true" > 2.1.< / strong > Keymap< / a > < / li > < li class = "chapter-item expanded " > < a href = "commands.html" > < strong aria-hidden = "true" > 2.2.< / strong > Commands< / a > < / li > < li class = "chapter-item expanded " > < a href = "lang-support.html" > < strong aria-hidden = "true" > 2.3.< / strong > Language Support< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "from-vim.html" > < strong aria-hidden = "true" > 3.< / strong > Migrating from Vim< / a > < / li > < li class = "chapter-item expanded " > < a href = "configuration.html" class = "active" > < strong aria-hidden = "true" > 4.< / strong > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "themes.html" > < strong aria-hidden = "true" > 4.1.< / strong > Themes< / a > < / li > < li class = "chapter-item expanded " > < a href = "remapping.html" > < strong aria-hidden = "true" > 4.2.< / strong > Key Remapping< / a > < / li > < li class = "chapter-item expanded " > < a href = "languages.html" > < strong aria-hidden = "true" > 4.3.< / strong > Languages< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "guides/index.html" > < strong aria-hidden = "true" > 5.< / strong > Guides< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "guides/adding_languages.html" > < strong aria-hidden = "true" > 5.1.< / strong > Adding Languages< / a > < / li > < li class = "chapter-item expanded " > < a href = "guides/textobject.html" > < strong aria-hidden = "true" > 5.2.< / strong > Adding Textobject Queries< / a > < / li > < li class = "chapter-item expanded " > < a href = "guides/indent.html" > < strong aria-hidden = "true" > 5.3.< / strong > Adding Indent Queries< / 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< / 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 (default)< / 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 >
< / 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 = "configuration" > < a class = "header" href = "#configuration" > Configuration< / a > < / h1 >
< p > To override global configuration parameters, create a < code > config.toml< / code > file located in your config directory:< / p >
< ul >
< li > Linux and Mac: < code > ~/.config/helix/config.toml< / code > < / li >
< li > Windows: < code > %AppData%\helix\config.toml< / code > < / li >
< / ul >
< blockquote >
< p > Hint: 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"
[editor]
line-number = " relative"
mouse = false
[editor.cursor-shape]
insert = " bar"
normal = " block"
select = " underline"
[editor.file-picker]
hidden = false
< / code > < / pre >
< p > You may also specify a file to use for configuration with the < code > -c< / code > or
< code > --config< / code > CLI argument: < code > hx -c path/to/custom-config.toml< / code > .< / p >
< p > It is also possible to trigger configuration file reloading by sending the < code > USR1< / code >
signal to the helix process, e.g. via < code > pkill -USR1 hx< / code > . This is only supported
on unix operating systems.< / p >
< h2 id = "editor" > < a class = "header" href = "#editor" > Editor< / a > < / h2 >
< h3 id = "editor-section" > < a class = "header" href = "#editor-section" > < code > [editor]< / 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 > scrolloff< / code > < / td > < td > Number of lines of padding around the edge of the screen when scrolling.< / td > < td > < code > 5< / code > < / td > < / tr >
< 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 > 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 > 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 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 > 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 > auto-info< / code > < / td > < td > Whether to display infoboxes< / td > < td > < code > true< / code > < / td > < / tr >
< tr > < td > < code > true-color< / code > < / td > < td > Set to < code > true< / code > to override automatic detection of terminal truecolor 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 > 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 >
< / 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 > 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"
< / 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" ]< / 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" , " 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 >
< div class = "table-wrapper" > < table > < thead > < tr > < th > Key< / th > < th > Description< / th > < / tr > < / thead > < tbody >
< 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-base-name< / code > < / td > < td > The basename of the opened file< / td > < / tr >
< tr > < td > < code > file-encoding< / code > < / td > < td > The encoding of the opened file if it differs from UTF-8< / td > < / tr >
< tr > < td > < code > file-line-ending< / code > < / td > < td > The file line endings (CRLF or LF)< / td > < / tr >
< tr > < td > < code > total-line-numbers< / code > < / td > < td > The total line numbers of the opened file< / td > < / tr >
< tr > < td > < code > file-type< / code > < / td > < td > The type of the opened file< / td > < / tr >
< tr > < td > < code > diagnostics< / code > < / td > < td > The number of warnings and/or errors< / td > < / tr >
< tr > < td > < code > workspace-diagnostics< / code > < / td > < td > The number of warnings and/or errors on workspace< / td > < / tr >
< tr > < td > < code > selections< / code > < / td > < td > The number of active selections< / td > < / tr >
< 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 > spacer< / code > < / td > < td > Inserts a space between elements (multiple/contiguous spacers may be specified)< / td > < / tr >
< / tbody > < / table >
< / div >
< h3 id = "editorlsp-section" > < a class = "header" href = "#editorlsp-section" > < code > [editor.lsp]< / 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 > display-messages< / code > < / td > < td > Display LSP progress messages below statusline< sup class = "footnote-reference" > < a href = "#1" > 1< / a > < / sup > < / td > < td > < code > false< / code > < / td > < / tr >
< tr > < td > < code > auto-signature-help< / code > < / td > < td > Enable automatic popup of signature help (parameter hints)< / td > < td > < code > true< / code > < / td > < / tr >
< tr > < td > < code > display-signature-help-docs< / code > < / td > < td > Display docs under signature help popup< / td > < td > < code > true< / code > < / td > < / tr >
< / tbody > < / table >
< / div >
< div class = "footnote-definition" id = "1" > < sup class = "footnote-definition-label" > 1< / sup >
< p > By default, a progress spinner is shown in the statusline beside the file path.< / p >
< / div >
< h3 id = "editorcursor-shape-section" > < a class = "header" href = "#editorcursor-shape-section" > < code > [editor.cursor-shape]< / code > Section< / a > < / h3 >
< p > Defines the shape of cursor in each mode. Note that due to limitations
of the terminal environment, only the primary cursor can change shape.
Valid values for these options are < code > block< / code > , < code > bar< / code > , < code > underline< / code > , or < code > hidden< / code > .< / p >
< div class = "table-wrapper" > < table > < thead > < tr > < th > Key< / th > < th > Description< / th > < th > Default< / th > < / tr > < / thead > < tbody >
< tr > < td > < code > normal< / code > < / td > < td > Cursor shape in < a href = "./keymap.html#normal-mode" > normal mode< / a > < / td > < td > < code > block< / code > < / td > < / tr >
< tr > < td > < code > insert< / code > < / td > < td > Cursor shape in < a href = "./keymap.html#insert-mode" > insert mode< / a > < / td > < td > < code > block< / code > < / td > < / tr >
< tr > < td > < code > select< / code > < / td > < td > Cursor shape in < a href = "./keymap.html#select--extend-mode" > select mode< / a > < / td > < td > < code > block< / code > < / td > < / tr >
< / tbody > < / table >
< / div >
< h3 id = "editorfile-picker-section" > < a class = "header" href = "#editorfile-picker-section" > < code > [editor.file-picker]< / code > Section< / a > < / h3 >
< p > 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, < code > max-depth< / code >
available, which is not defined by default.< / 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 > 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 .gitignore, 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 >
< / tbody > < / table >
< / div >
< 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 >
< p > To disable auto-pairs altogether, set < code > auto-pairs< / code > to < code > false< / code > :< / 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
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 >
< pre > < code class = "language-toml" > [[language]]
name = " rust"
[language.auto-pairs]
'(' = ')'
'{' = '}'
'[' = ']'
'" ' = '" '
'`' = '`'
'< ' = '> '
< / code > < / pre >
< h3 id = "editorsearch-section" > < a class = "header" href = "#editorsearch-section" > < code > [editor.search]< / code > Section< / a > < / h3 >
< p > Search specific options.< / p >
< div class = "table-wrapper" > < table > < thead > < tr > < th > Key< / th > < th > Description< / th > < th > Default< / th > < / tr > < / thead > < tbody >
< tr > < td > < code > smart-case< / code > < / td > < td > Enable smart case regex searching (case insensitive unless pattern contains upper case characters)< / td > < td > < code > true< / code > < / td > < / tr >
< tr > < td > < code > wrap-around< / code > < / td > < td > Whether the search should wrap after depleting the matches< / td > < td > < code > true< / code > < / td > < / tr >
< / tbody > < / table >
< / div >
< 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 >
< / tbody > < / table >
< / div >
< p > Example< / p >
< pre > < code class = "language-toml" > [editor.whitespace]
render = " all"
# or control each character
[editor.whitespace.render]
space = " all"
tab = " all"
newline = " none"
[editor.whitespace.characters]
space = " ·"
nbsp = " ⍽"
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 >
< 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 indent guides.< / td > < td > < code > false< / code > < / td > < / tr >
< tr > < td > < code > character< / code > < / td > < td > Literal character to use for rendering the indent guide< / td > < td > < code > │< / code > < / td > < / tr >
< tr > < td > < code > skip-levels< / code > < / td > < td > Number of indent levels to skip< / td > < td > < code > 0< / code > < / td > < / tr >
< / tbody > < / table >
< / div >
< p > Example:< / p >
< pre > < code class = "language-toml" > [editor.indent-guides]
render = true
character = " ╎" # Some characters that work well: " ▏" , " ┆" , " ┊" , " ⸽"
skip-levels = 1
< / 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" ]
< / 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 sub-sections.< / 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 >
< / tbody > < / table >
< / div >
< p > Example:< / p >
< pre > < code class = "language-toml" > [editor.gutters]
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 >
< div class = "table-wrapper" > < table > < thead > < tr > < th > Key< / th > < th > Description< / th > < th > Default< / th > < / tr > < / thead > < tbody >
< tr > < td > < code > min-width< / code > < / td > < td > The minimum number of characters to use< / td > < td > < code > 3< / code > < / td > < / tr >
< / tbody > < / table >
< / div >
< p > Example:< / p >
< pre > < code class = "language-toml" > [editor.gutters.line-numbers]
min-width = 1
< / code > < / pre >
< h4 id = "editorguttersdiagnotics-section" > < a class = "header" href = "#editorguttersdiagnotics-section" > < code > [editor.gutters.diagnotics]< / 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 >
< 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 >
< p > Options for soft wrapping lines that exceed the view width< / 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 > Whether soft wrapping is enabled.< / td > < td > < code > false< / code > < / td > < / tr >
< tr > < td > < code > max-wrap< / code > < / td > < td > Maximum free space left at the end of the line.< / td > < td > < code > 20< / code > < / td > < / tr >
< tr > < td > < code > max-indent-retain< / code > < / td > < td > Maximum indentation to carry over when soft wrapping a line.< / td > < td > < code > 40< / code > < / td > < / tr >
< tr > < td > < code > wrap-indicator< / code > < / td > < td > Text inserted before soft wrapped lines, highlighted with < code > ui.virtual.wrap< / code > < / td > < td > < code > ↪ < / code > < / td > < / tr >
< / tbody > < / table >
< / div >
< p > Example:< / p >
< pre > < code class = "language-toml" > [editor.soft-wrap]
enable = true
max-wrap = 25 # increase value to reduce forced mid-word wrapping
max-indent-retain = 0
wrap-indicator = " " # set wrap-indicator to " " to hide it
< / code > < / pre >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "from-vim.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 = "themes.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 = "from-vim.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 = "themes.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 >
