Added a keybinds section to display specs whenever

This section shows the user the availability of the `show_specs()` function which gives them the ability to add it to keybinds to find the cursor easily. Shows them example use cases as well outside of just invoking it regularly.
This commit is contained in:
Shadorain 2021-10-11 17:52:19 +00:00 committed by GitHub
parent a62319a224
commit 6efd3e066d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -80,6 +80,21 @@ require('specs').setup{
}
}
```
### Keybinds
You can invoke specs from anywhere by using `:lua require('specs').show_specs()`
Add a keybind for this to make it easy to find your cursor at any time.
```lua
-- Press <C-b> to call specs!
vim.api.nvim_set_keymap('n', '<C-b>', ':lua require("specs").show_specs()', { noremap = true, silent = true })
-- You can even bind it to search jumping and more, example:
vim.api.nvim_set_keymap('n', 'n', 'n:lua require("specs").show_specs()<CR>', { noremap = true, silent = true })
vim.api.nvim_set_keymap('n', 'N', 'N:lua require("specs").show_specs()<CR>', { noremap = true, silent = true })
```
## Planned Features
- [ ] More builtin faders + resizers
- [ ] Colorizers