diff options
Diffstat (limited to 'book/src/configuration.md')
| -rw-r--r-- | book/src/configuration.md | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/book/src/configuration.md b/book/src/configuration.md index ab229f77..528fafd0 100644 --- a/book/src/configuration.md +++ b/book/src/configuration.md @@ -307,4 +307,25 @@ Currently unused #### `[editor.gutters.spacer]` Section -Currently unused
\ No newline at end of file +Currently unused + +### `[editor.soft-wrap]` Section + +Options for soft wrapping lines that exceed the view width + +| Key | Description | Default | +| --- | --- | --- | +| `enable` | Whether soft wrapping is enabled. | `false` | +| `max-wrap` | Maximum free space left at the end of the line. | `20` | +| `max-indent-retain` | Maximum indentation to carry over when soft wrapping a line. | `40` | +| `wrap-indicator` | Text inserted before soft wrapped lines, highlighted with `ui.virtual.wrap` | `↪ ` | + +Example: + +```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 +``` |