diff options
Diffstat (limited to 'book/src/usage.md')
| -rw-r--r-- | book/src/usage.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/book/src/usage.md b/book/src/usage.md index 8f04b05a..e6bd60e2 100644 --- a/book/src/usage.md +++ b/book/src/usage.md @@ -1 +1,26 @@ # Usage + +(Currently not fully documented, see the [keymappings](./keymap.md) list for more.) + +## Surround + +Functionality similar to [vim-surround](https://github.com/tpope/vim-surround) is built into +helix. The keymappings have been inspired from [vim-sandwich](https://github.com/machakann/vim-sandwich): + + + +- `ms` - Add surround characters +- `mr` - Replace surround characters +- `md` - Delete surround characters + +`ms` acts on a selection, so select the text first and use `ms<char>`. `mr` and `md` work +on the closest pairs found and selections are not required; use counts to act in outer pairs. + +It can also act on multiple seletions (yay!). For example, to change every occurance of `(use)` to `[use]`: + +- `%` to select the whole file +- `s` to split the selections on a search term +- Input `use` and hit Enter +- `mr([` to replace the parens with square brackets + +Multiple characters are currently not supported, but planned. |