summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorfdschmidt93 <39233597+fdschmidt93@users.noreply.github.com>2021-10-04 20:30:32 +0200
committerGitHub <noreply@github.com>2021-10-04 20:30:32 +0200
commite39ed31f17e35d4f42b516d10ed4340fca25eb6a (patch)
treea033b4a94bf86146f4f39580514956dacc424757
parent440c598de419858a056e7d9d42a0a6829cd5bb05 (diff)
chore: highlight which_key on README (#1298)
-rw-r--r--README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/README.md b/README.md
index cd7fcfe..20eb13a 100644
--- a/README.md
+++ b/README.md
@@ -139,7 +139,14 @@ require('telescope').setup{
defaults = {
-- Default configuration for telescope goes here:
-- config_key = value,
- -- ..
+ mappings = {
+ i = {
+ -- map actions.which_key to <C-h> (default: <C-/>)
+ -- actions.which_key shows the mappings for your picker,
+ -- e.g. git_{create, delete, ...}_branch for the git_branches picker
+ ["<C-h>"] = "which_key"
+ }
+ }
},
pickers = {
-- Default configuration for builtin pickers goes here:
@@ -194,7 +201,8 @@ Many familiar mapping patterns are setup as defaults.
| `<C-t>` | Go to a file in a new tab |
| `<C-u>` | Scroll up in preview window |
| `<C-d>` | Scroll down in preview window |
-| `<C-/>/?` | Show picker mappings (in insert & normal mode, respectively) |
+| `<C-/>` | Show mappings for picker actions (insert mode)|
+| `?` | Show mappings for picker actions (normal mode)|
| `<C-c>` | Close telescope |
| `<Esc>` | Close telescope (in normal mode) |
| `<Tab>` | Toggle selection and move to next selection |
@@ -204,7 +212,9 @@ Many familiar mapping patterns are setup as defaults.
To see the full list of mappings, check out `lua/telescope/mappings.lua` and the
-`default_mappings` table.
+`default_mappings` table.
+
+**Tip**: you can use `<C-/>` and `?` in insert and normal mode, respectively, to show the actions mapped to your picker.
Much like [builtin pickers](#pickers), there are a number of
[actions](https://github.com/nvim-telescope/telescope.nvim/blob/master/lua/telescope/actions/init.lua)