Skip to content

Commit

Permalink
chore: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjones2014 committed Oct 11, 2023
1 parent 1c3b811 commit be1de69
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 46 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ Define your keymaps, commands, and autocommands as simple Lua tables, building a
- [Configuration](#configuration)
- [Troubleshooting Frecency Sort](#troubleshooting-frecency-sort)
- [Keymap Development Utilities](./doc/MAPPING_DEVELOPMENT.md)
- [`which-key.nvim` Integration](./doc/WHICH_KEY.md)
- [Lua API](./doc/API.md)
- [Extensions](./doc/EXTENSIONS.md)
- [Table Structures](./doc/table_structures/README.md)
Expand All @@ -34,8 +33,8 @@ Define your keymaps, commands, and autocommands as simple Lua tables, building a
## Features

- Define your keymaps, commands, `augroup`/`autocmd`s, and even arbitrary Lua functions to run on the fly, as simple Lua tables, then bind them with `legendary.nvim`
- Integration with [which-key.nvim](https://github.com/folke/which-key.nvim), use your existing `which-key.nvim` tables with `legendary.nvim`
- Integration with [lazy.nvim](https://github.com/folke/lazy.nvim), automatically load keymaps defined via `lazy.nvim`'s `keys` property on plugin specs
- Integration with [which-key.nvim](https://github.com/folke/which-key.nvim), use your existing `which-key.nvim` tables with `legendary.nvim` (see [extensions](./doc/EXTENSIONS.md#which-keynvim))
- Integration with [lazy.nvim](https://github.com/folke/lazy.nvim), automatically load keymaps defined via `lazy.nvim`'s `keys` property on plugin specs (see [extensions](./doc/EXTENSIONS.md#lazynvim))
- Execute normal, insert, and visual mode keymaps, commands, autocommands, and Lua functions when you select them
- Show your most recently executed items at the top when triggered via `legendary.nvim` (can be disabled via config)
- Uses `vim.ui.select()` so it can be hooked up to a fuzzy finder using something like [dressing.nvim](https://github.com/stevearc/dressing.nvim) for a VS Code command palette like interface
Expand Down
5 changes: 4 additions & 1 deletion doc/EXTENSIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,16 @@ into `legendary.nvim`.
require('legendary').setup({
extensions = {
lazy_nvim = true,
}
},
})
```

### `Which-Key.nvim`

Automatically load key mappings defined by [which-key.nvim](https://github.com/folke/which-key.nvim) into `legendary.nvim`.
For `auto_register` to work, `which-key.nvim` must be loaded on `runtimepath` before `legendary.nvim` initializes,
but `legendary.nvim` must initialize the extension before `require('which-key').register()` is called. Alternatively,
you can just pass your `which-key` tables to `legendary` directly.

```lua
require('legendary').setup({
Expand Down
42 changes: 0 additions & 42 deletions doc/WHICH_KEY.md

This file was deleted.

0 comments on commit be1de69

Please sign in to comment.