Skip to content

add Vim help #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Konfekt wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add Vim help #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions doc/vim-peekaboo.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
vim-peekaboo.txt

================================================================================
CONTENTS *peekaboo-contents*

1. vim-peekaboo........................................|peekaboo-vim-peekaboo|
1.1. Installation..................................|peekaboo-installation|
1.2. Usage................................................|peekaboo-usage|
1.3. Customization................................|peekaboo-customization|
1.4. License............................................|peekaboo-license|

================================================================================
VIM-PEEKABOO *peekaboo-vim-peekaboo*



Peekaboo extends `"` and `@` in normal mode and `<CTRL-R>` in insert mode so
you can see the contents of the registers.

--------------------------------------------------------------------------------
INSTALLATION *peekaboo-installation*

Using vim-plug (https://github.com/junegunn/vim-plug):
>
Plug 'junegunn/vim-peekaboo'
<

--------------------------------------------------------------------------------
USAGE *peekaboo-usage*

Peekaboo will show you the contents of the registers on the sidebar when you
hit `"` or `@` in normal mode or `<CTRL-R>` in insert mode. The sidebar is
automatically closed on subsequent key strokes.

You can toggle fullscreen mode by pressing spacebar.

--------------------------------------------------------------------------------
CUSTOMIZATION *peekaboo-customization*

| Config | Default | Description |
| ------ | ------- | ----------- |
| `g:peekaboo_window` | | Command for creating Peekaboo window |
| `g:peekaboo_delay` | 0 (ms) | Delay opening of Peekaboo window |
| `g:peekaboo_compact` | 0 (boolean) | Compact display |
| `g:peekaboo_prefix` | Empty (string) | Prefix for key mapping (e.g. `<leader>`) |
| `g:peekaboo_ins_prefix` | Empty (string) | Prefix for insert mode key mapping (e.g. `<c-x>`) |

--------------------------------------------------------------------------------
LICENSE *peekaboo-license*

MIT

vim:tw=78:ts=8:ft=help:norl: