Unnamed repository; edit this file 'description' to name the repository.
Diffstat (limited to 'book/src/configuration.md')
| -rw-r--r-- | book/src/configuration.md | 55 |
1 files changed, 26 insertions, 29 deletions
diff --git a/book/src/configuration.md b/book/src/configuration.md index 317007ef..7d6ff28f 100644 --- a/book/src/configuration.md +++ b/book/src/configuration.md @@ -2,34 +2,31 @@ To override global configuration parameters, create a `config.toml` file located in your config directory: -- Linux and Mac: `~/.config/helix/config.toml` -- Windows: `%AppData%\helix\config.toml` - -> 💡 You can easily open the config file by typing `:config-open` within Helix normal mode. - -Example config: - +* Linux and Mac: `~/.config/helix/config.toml` +* Windows: `%AppData%\helix\config.toml` + +## Editor + +`[editor]` section of the config. + +| Key | Description | Default | +|--|--|---------| +| `scrolloff` | Number of lines of padding around the edge of the screen when scrolling. | `3` | +| `mouse` | Enable mouse mode. | `true` | +| `middle-click-paste` | Middle click paste support. | `true` | +| `scroll-lines` | Number of lines to scroll per scroll wheel step. | `3` | +| `shell` | Shell to use when running external commands. | Unix: `["sh", "-c"]`<br/>Windows: `["cmd", "/C"]` | +| `line-number` | Line number display (`absolute`, `relative`) | `absolute` | +| `smart-case` | Enable smart case regex searching (case insensitive unless pattern contains upper case characters) | `true` | +| `auto-pairs` | Enable automatic insertion of pairs to parenthese, brackets, etc. | `true` | +| `auto-completion` | Enable automatic pop up of auto-completion. | `true` | +| `idle-timeout` | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | `400` | +| `completion-trigger-len` | The min-length of word under cursor to trigger autocompletion | `2` | + +## LSP + +To display all language server messages in the status line add the following to your `config.toml`: ```toml -theme = "onedark" - -[editor] -line-number = "relative" -mouse = false - -[editor.cursor-shape] -insert = "bar" -normal = "block" -select = "underline" - -[editor.file-picker] -hidden = false +[lsp] +display-messages = true ``` - -You can use a custom configuration file by specifying it with the `-c` or -`--config` command line argument, for example `hx -c path/to/custom-config.toml`. -You can reload the config file by issuing the `:config-reload` command. Alternatively, on Unix operating systems, you can reload it by sending the USR1 -signal to the Helix process, such as by using the command `pkill -USR1 hx`. - -Finally, you can have a `config.toml` local to a project by putting it under a `.helix` directory in your repository. -Its settings will be merged with the configuration directory `config.toml` and the built-in configuration. - |