diff --git a/README.md b/README.md index fef08edb..994eeaa6 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,13 @@ require("lazy").setup({ ## ⌨️ Keymaps +**LazyVim** uses [which-key.nvim](https://github.com/folke/which-key) to help you remember your +keymaps. Just press any key like `` and you'll see a popup with all +possible keymaps starting with ``. + -### General +
General | Key | Description | Mode | | -------------------- | -------------------------- | -------------------------- | @@ -72,7 +76,7 @@ require("lazy").setup({ | `fn` | New File | **n** | | `xl` | Open Location List | **n** | | `xq` | Open Quickfix List | **n** | -| `tf` | Toggle Format on Save | **n** | +| `tf` | Toggle format on Save | **n** | | `ts` | Toggle Spelling | **n** | | `tw` | Toggle Word Wrap | **n** | | `tn` | Toggle Line Numbers | **n** | @@ -100,7 +104,9 @@ require("lazy").setup({ | `b[` | Previous Buffer | **n** | | `` ` `` | Switch to Other Buffer | **n** | -### LSP +
+ +
LSP | Key | Description | Mode | | ------------ | --------------------- | ------------ | @@ -125,7 +131,9 @@ require("lazy").setup({ | `cf` | Format Range | **v** | | `cr` | Rename | **n** | -### Plugins +
+ +
Plugins | Key | Description | Mode | | ----------------- | ---------------------------------------------------------------------------------------------- | ----- | @@ -178,6 +186,8 @@ require("lazy").setup({ | `]]` | [vim-illuminate](https://github.com/RRethy/vim-illuminate.git) Next Reference | **n** | | `[[` | [vim-illuminate](https://github.com/RRethy/vim-illuminate.git) Prev Reference | **n** | +
+ ## 📦 Plugins diff --git a/lua/lazyvim/util/build.lua b/lua/lazyvim/util/build.lua index 21525e43..4b28c0b5 100644 --- a/lua/lazyvim/util/build.lua +++ b/lua/lazyvim/util/build.lua @@ -56,7 +56,7 @@ function M.keymaps() local lines = {} for _, group in ipairs(groups) do - lines[#lines + 1] = "### " .. group + lines[#lines + 1] = "
" .. group .. "" lines[#lines + 1] = "" vim.list_extend(lines, { "| Key | Description | Mode |", "| --- | --- | --- |" }) local mappings = vim.tbl_filter(function(m) @@ -82,6 +82,8 @@ function M.keymaps() .. " |" end lines[#lines + 1] = "" + lines[#lines + 1] = "
" + lines[#lines + 1] = "" end return table.concat(lines, "\n") end