https://github.com/nvzone/showkeys

Minimal Eye-candy keys screencaster for Neovim 200 ~ LOC
https://github.com/nvzone/showkeys

beautiful keys lua neovim neovim-plugin nvchad nvim screenkey

Last synced: 6 months ago
JSON representation

Minimal Eye-candy keys screencaster for Neovim 200 ~ LOC

• Host: GitHub
• URL: https://github.com/nvzone/showkeys
• Owner: nvzone
• License: gpl-3.0
• Created: 2024-10-07T01:00:07.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-24T02:27:18.000Z (9 months ago)
• Last Synced: 2025-04-13T02:07:02.856Z (6 months ago)
• Topics: beautiful, keys, lua, neovim, neovim-plugin, nvchad, nvim, screenkey
• Language: Lua
• Homepage:
• Size: 42 KB
• Stars: 243
• Watchers: 1
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Showkeys

Eye-candy keys screencaster for Neovim

https://github.com/user-attachments/assets/a85d6546-b457-49b6-aca6-c9b0410d3512

  

## Install

```lua

{ "nvzone/showkeys", cmd = "ShowkeysToggle" }

```

## Usage

`ShowkeysToggle`

## Config

Check the [config table here](https://github.com/NvChad/showkeys/blob/main/lua/showkeys/state.lua#L7)

```lua

{

  "nvzone/showkeys",

  cmd = "ShowkeysToggle",

  opts = {

    timeout = 1,

    maxkeys = 5,

    -- more opts

  }

}

```

## :gift_heart: Support

If you like NvChad or its plugins and would like to support it via donation

[![kofi](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/siduck)

[![paypal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/siduck13)

[![buymeacoffee](https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge&logo=buy-me-a-coffee&logoColor=black)](https://www.buymeacoffee.com/siduck)

[![patreon](https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white)](https://www.patreon.com/siduck)