docs: cleanup keymaps

This commit is contained in:
Folke Lemaitre
2023-01-09 08:37:42 +01:00
parent 011356e70e
commit c2f124c204
2 changed files with 17 additions and 5 deletions

View File

@ -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 `<space>` and you'll see a popup with all
possible keymaps starting with `<space>`.
<!-- keymaps:start -->
### General
<details><summary>General</summary>
| Key | Description | Mode |
| -------------------- | -------------------------- | -------------------------- |
@ -72,7 +76,7 @@ require("lazy").setup({
| `<leader>fn` | New File | **n** |
| `<leader>xl` | Open Location List | **n** |
| `<leader>xq` | Open Quickfix List | **n** |
| `<leader>tf` | Toggle Format on Save | **n** |
| `<leader>tf` | Toggle format on Save | **n** |
| `<leader>ts` | Toggle Spelling | **n** |
| `<leader>tw` | Toggle Word Wrap | **n** |
| `<leader>tn` | Toggle Line Numbers | **n** |
@ -100,7 +104,9 @@ require("lazy").setup({
| `<leader>b[` | Previous Buffer | **n** |
| `` <leader>` `` | Switch to Other Buffer | **n** |
### LSP
</details>
<details><summary>LSP</summary>
| Key | Description | Mode |
| ------------ | --------------------- | ------------ |
@ -125,7 +131,9 @@ require("lazy").setup({
| `<leader>cf` | Format Range | **v** |
| `<leader>cr` | Rename | **n** |
### Plugins
</details>
<details><summary>Plugins</summary>
| 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** |
</details>
<!-- keymaps:end -->
## 📦 Plugins

View File

@ -56,7 +56,7 @@ function M.keymaps()
local lines = {}
for _, group in ipairs(groups) do
lines[#lines + 1] = "### " .. group
lines[#lines + 1] = "<details><summary>" .. group .. "</summary>"
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] = "</details>"
lines[#lines + 1] = ""
end
return table.concat(lines, "\n")
end