Improve documentation of key bindings in README (#687)
This commit is contained in:
parent
2b6fa274a8
commit
1e5c93ea91
13
README.md
13
README.md
@ -178,7 +178,13 @@ For other syntax elements, see `:h vimwiki-syntax`
|
|||||||
|
|
||||||
## Key bindings
|
## Key bindings
|
||||||
|
|
||||||
Normal mode:
|
### Normal mode
|
||||||
|
|
||||||
|
**Note:** your terminal may prevent capturing some of the default bindings
|
||||||
|
listed below. See `:h vimwiki-local-mappings` for suggestions for alternative
|
||||||
|
bindings if you encounter a problem.
|
||||||
|
|
||||||
|
#### Basic key bindings
|
||||||
|
|
||||||
* `<Leader>ww` -- Open default wiki index file.
|
* `<Leader>ww` -- Open default wiki index file.
|
||||||
* `<Leader>wt` -- Open default wiki index file in a new tab.
|
* `<Leader>wt` -- Open default wiki index file in a new tab.
|
||||||
@ -192,7 +198,10 @@ Normal mode:
|
|||||||
* `<Tab>` -- Find next wiki link
|
* `<Tab>` -- Find next wiki link
|
||||||
* `<Shift-Tab>` -- Find previous wiki link
|
* `<Shift-Tab>` -- Find previous wiki link
|
||||||
|
|
||||||
For more keys, see `:h vimwiki-mappings`
|
#### Advanced key bindings
|
||||||
|
|
||||||
|
Refer to the complete documentation at `:h vimwiki-mappings` to see many
|
||||||
|
more bindings.
|
||||||
|
|
||||||
## Commands
|
## Commands
|
||||||
|
|
||||||
|
@ -3311,6 +3311,7 @@ Contributors and their Github usernames in roughly chronological order:
|
|||||||
- Steven Stallion (@sstallion)
|
- Steven Stallion (@sstallion)
|
||||||
- Rane Brown (@ranebrown)
|
- Rane Brown (@ranebrown)
|
||||||
- Patrik Willard (@padowi)
|
- Patrik Willard (@padowi)
|
||||||
|
- Steve Dondley (@sdondley)
|
||||||
|
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
@ -3326,6 +3327,8 @@ https://github.com/vimwiki-backup/vimwiki/issues.
|
|||||||
2.5 (in progress)~
|
2.5 (in progress)~
|
||||||
|
|
||||||
New:~
|
New:~
|
||||||
|
* PR #683: Improve layout and format of key binding documentation in
|
||||||
|
README and include note about key bindings that may not work.
|
||||||
* PR #675: Add option |vimwiki-option-name| to assign a per wiki name.
|
* PR #675: Add option |vimwiki-option-name| to assign a per wiki name.
|
||||||
* PR #661: Add option |g:vimwiki_auto_header| to automatically generate
|
* PR #661: Add option |g:vimwiki_auto_header| to automatically generate
|
||||||
a level 1 header for new wiki pages.
|
a level 1 header for new wiki pages.
|
||||||
|
Loading…
Reference in New Issue
Block a user