https://github.com/wsdjeg/record-key.nvim
Recording keyboard keys in Neovim
https://github.com/wsdjeg/record-key.nvim
neovim-plugin
Last synced: 25 days ago
JSON representation
Recording keyboard keys in Neovim
- Host: GitHub
- URL: https://github.com/wsdjeg/record-key.nvim
- Owner: wsdjeg
- Created: 2024-12-20T00:04:08.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-04-21T14:00:20.000Z (27 days ago)
- Last Synced: 2025-04-21T15:24:01.756Z (27 days ago)
- Topics: neovim-plugin
- Language: Lua
- Homepage:
- Size: 38.1 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# record-key.nvim
> _record-key.nvim_ is plugin to display pressed key in neovim.
https://github.com/user-attachments/assets/40bd3805-c4f1-4ba5-a028-983a01a072b7
* [Installation](#installation)
* [Setup](#setup)
* [Usage](#usage)
* [Debug](#debug)
* [Feedback](#feedback)
## Installation
Use your preferred Neovim plugin manager to install record-key.nvim.
with [nvim-plug](https://github.com/wsdjeg/nvim-plug)
```lua
require('plug').add({
{
'wsdjeg/record-key.nvim',
cmds = { 'RecordKeyToggle' },
config_before = function()
vim.keymap.set('n', 'rk', 'RecordKeyToggle', { silent = true })
end,
},
})
```
Then use `:PlugInstall record-key.nvim` to install this plugin.
## Setup
```lua
require('record-key').setup({
timeout = 3000,
max_count = 5,
winhighlight = 'NormalFloat:Normal,FloatBorder:WinSeparator',
})
```
## Usage
- `:RecordKeyToggle`: toggle record-key
## Debug
Debug record-key.nvim with logger.nvim:
```lua
require('plug').add({
{
'wsdjeg/record-key.nvim',
cmds = { 'RecordKeyToggle' },
config_before = function()
vim.keymap.set('n', 'rk', 'RecordKeyToggle', { silent = true })
end,
depends = {
{
'wsdjeg/logger.nvim',
},
},
},
})
```
## Feedback
If you encounter any bugs or have suggestions, please file an issue in the [issue tracker](https://github.com/wsdjeg/record-key.nvim/issues)