<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< 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 ? "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" class = "active" > < strong aria-hidden = "true" > 3.< / strong > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "keymap.html" > < strong aria-hidden = "true" > 3.1.< / strong > Keymap< / a > < / li > < li class = "chapter-item expanded " > < a href = "hooks.html" > < strong aria-hidden = "true" > 3.2.< / 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 = "configuration" > < a class = "header" href = "#configuration" > Configuration< / a > < / h1 >
< h2 id = "theme" > < a class = "header" href = "#theme" > Theme< / a > < / h2 >
< p > Use a custom theme by placing a theme.toml in your config directory (i.e ~/.config/helix/theme.toml). The default theme.toml can be found < a href = "https://github.com/helix-editor/helix/blob/master/theme.toml" > here< / a > , and user submitted themes < a href = "https://github.com/helix-editor/helix/blob/master/contrib/themes" > here< / a > .< / p >
< p > Styles in theme.toml are specified of in the form:< / p >
< pre > < code class = "language-toml" > key = { fg = " #ffffff" , bg = " #000000" , modifiers = [" bold" , " italic" ] }
< / code > < / pre >
< p > where < code > name< / code > represents what you want to style, < code > fg< / code > specifies the foreground color, < code > bg< / code > the background color, and < code > modifiers< / code > is a list of style modifiers. < code > bg< / code > and < code > modifiers< / code > can be omitted to defer to the defaults.< / p >
< p > To specify only the foreground color:< / p >
< pre > < code class = "language-toml" > key = " #ffffff"
< / code > < / pre >
< p > if the key contains a dot < code > '.'< / code > , it must be quoted to prevent it being parsed as a < a href = "https://toml.io/en/v1.0.0#keys" > dotted key< / a > .< / p >
< pre > < code class = "language-toml" > " key.key" = " #ffffff"
< / code > < / pre >
< p > Possible modifiers:< / p >
< table > < thead > < tr > < th > modifier< / th > < / tr > < / thead > < tbody >
< tr > < td > bold< / td > < / tr >
< tr > < td > dim< / td > < / tr >
< tr > < td > italic< / td > < / tr >
< tr > < td > underlined< / td > < / tr >
< tr > < td > slow_blink< / td > < / tr >
< tr > < td > rapid_blink< / td > < / tr >
< tr > < td > reversed< / td > < / tr >
< tr > < td > hidden< / td > < / tr >
< tr > < td > crossed_out< / td > < / tr >
< / tbody > < / table >
< p > Possible keys:< / p >
< table > < thead > < tr > < th > key< / th > < th > notes< / th > < / tr > < / thead > < tbody >
< tr > < td > attribute< / td > < td > < / td > < / tr >
< tr > < td > keyword< / td > < td > < / td > < / tr >
< tr > < td > keyword.directive< / td > < td > preprocessor directives (#if in C)< / td > < / tr >
< tr > < td > namespace< / td > < td > < / td > < / tr >
< tr > < td > punctuation< / td > < td > < / td > < / tr >
< tr > < td > punctuation.delimiter< / td > < td > < / td > < / tr >
< tr > < td > operator< / td > < td > < / td > < / tr >
< tr > < td > special< / td > < td > < / td > < / tr >
< tr > < td > property< / td > < td > < / td > < / tr >
< tr > < td > variable< / td > < td > < / td > < / tr >
< tr > < td > variable.parameter< / td > < td > < / td > < / tr >
< tr > < td > type< / td > < td > < / td > < / tr >
< tr > < td > type.builtin< / td > < td > < / td > < / tr >
< tr > < td > constructor< / td > < td > < / td > < / tr >
< tr > < td > function< / td > < td > < / td > < / tr >
< tr > < td > function.macro< / td > < td > < / td > < / tr >
< tr > < td > function.builtin< / td > < td > < / td > < / tr >
< tr > < td > comment< / td > < td > < / td > < / tr >
< tr > < td > variable.builtin< / td > < td > < / td > < / tr >
< tr > < td > constant< / td > < td > < / td > < / tr >
< tr > < td > constant.builtin< / td > < td > < / td > < / tr >
< tr > < td > string< / td > < td > < / td > < / tr >
< tr > < td > number< / td > < td > < / td > < / tr >
< tr > < td > escape< / td > < td > escaped characters< / td > < / tr >
< tr > < td > label< / td > < td > used for lifetimes< / td > < / tr >
< tr > < td > module< / td > < td > < / td > < / tr >
< tr > < td > ui.background< / td > < td > < / td > < / tr >
< tr > < td > ui.linenr< / td > < td > < / td > < / tr >
< tr > < td > ui.statusline< / td > < td > < / td > < / tr >
< tr > < td > ui.popup< / td > < td > < / td > < / tr >
< tr > < td > ui.window< / td > < td > < / td > < / tr >
< tr > < td > ui.help< / td > < td > < / td > < / tr >
< tr > < td > ui.text< / td > < td > < / td > < / tr >
< tr > < td > ui.text.focus< / td > < td > < / td > < / tr >
< tr > < td > ui.menu.selected< / td > < td > < / td > < / tr >
< tr > < td > ui.selection< / td > < td > for selections in the editing area< / td > < / tr >
< tr > < td > warning< / td > < td > LSP warning< / td > < / tr >
< tr > < td > error< / td > < td > LSP error< / td > < / tr >
< tr > < td > info< / td > < td > LSP info< / td > < / tr >
< tr > < td > hint< / td > < td > LSP hint< / td > < / tr >
< / tbody > < / table >
< p > These keys match < a href = "https://tree-sitter.github.io/tree-sitter/syntax-highlighting#theme" > tree-sitter scopes< / a > . We half-follow the common scopes from < a href = "https://macromates.com/manual/en/language_grammars" > macromates language grammars< / a > with some differences.< / p >
< p > For a given highlight produced, styling will be determined based on the longest matching theme key. So it's enough to provide function to highlight < code > function.macro< / code > and < code > function.builtin< / code > as well, but you can use more specific scopes to highlight specific cases differently.< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "usage.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 = "keymap.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 = "usage.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 = "keymap.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 >
