Skip to content

Commit

Permalink
Add FAQ in README
Browse files Browse the repository at this point in the history
Close #178
  • Loading branch information
liuchengxu committed Apr 2, 2021
1 parent 9b80ded commit 4cbfe3b
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
* [Hide statusline](#hide-statusline)
* [Commands](#commands)
* [Options](#options)
* [FAQ](#faq)
* [How to map some special keys like `<BS>`?](#how-to-map-some-special-keys-like-bs)
* [Credit](#credit)

<!-- /TOC -->
Expand Down Expand Up @@ -286,19 +288,25 @@ autocmd FileType which_key set laststatus=0 noshowmode noruler

See more details about commands and options via `:h vim-which-key`.

Command | Description
:---- | :----:
`:WhichKey {prefix}` | Open the guide window for the given prefix
`:WhichKey! {dict}` | Open the guide window for a given dictionary directly
| Command | Description |
| :------------------- | :---------------------------------------------------: |
| `:WhichKey {prefix}` | Open the guide window for the given prefix |
| `:WhichKey! {dict}` | Open the guide window for a given dictionary directly |

### Options

Variable | Default | Description
:---- | :----: | :----:
`g:which_key_vertical` | 0 | show popup vertically
`g:which_key_position` | `botright` | split a window at the bottom
`g:which_key_hspace` | 5 | minimum horizontal space between columns
`g:which_key_centered` | 1 | make all keybindings centered in the middle
| Variable | Default | Description |
| :--------------------- | :--------: | :-----------------------------------------: |
| `g:which_key_vertical` | 0 | show popup vertically |
| `g:which_key_position` | `botright` | split a window at the bottom |
| `g:which_key_hspace` | 5 | minimum horizontal space between columns |
| `g:which_key_centered` | 1 | make all keybindings centered in the middle |

### FAQ

#### How to map some special keys like `<BS>`?

See [#178](https://github.com/liuchengxu/vim-which-key/issues/178).

## Credit

Expand Down

0 comments on commit 4cbfe3b

Please sign in to comment.