Improve documentation of key bindings in README (#687)

This commit is contained in:
Steve Dondley 2019-04-25 10:18:41 -04:00 committed by Rane Brown
parent 2b6fa274a8
commit 1e5c93ea91
2 changed files with 15 additions and 3 deletions

View File

@ -178,7 +178,13 @@ For other syntax elements, see `:h vimwiki-syntax`
## 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>wt` -- Open default wiki index file in a new tab.
@ -192,7 +198,10 @@ Normal mode:
* `<Tab>` -- Find next 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

View File

@ -3311,6 +3311,7 @@ Contributors and their Github usernames in roughly chronological order:
- Steven Stallion (@sstallion)
- Rane Brown (@ranebrown)
- Patrik Willard (@padowi)
- Steve Dondley (@sdondley)
==============================================================================
@ -3326,6 +3327,8 @@ https://github.com/vimwiki-backup/vimwiki/issues.
2.5 (in progress)~
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 #661: Add option |g:vimwiki_auto_header| to automatically generate
a level 1 header for new wiki pages.