-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(flygrep): update flygrep readme
- Loading branch information
Showing
1 changed file
with
53 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,78 @@ | ||
| # FlyGrep.vim | ||
| > Asynchronously fly grep in vim | ||
|
|
||
| This plugin is automatically detach from [SpaceVim](https://github.com/SpaceVim/SpaceVim/). you can use it without SpaceVim. | ||
| [](https://spacevim.org) | ||
| [](LICENSE) | ||
|
|
||
|  | ||
|
|
||
| <!-- vim-markdown-toc GFM --> | ||
|
|
||
| - [Intro](#intro) | ||
| - [Install](#install) | ||
| - [Usage](#usage) | ||
| - [Command](#command) | ||
| - [Key bindings in FlyGrep window](#key-bindings-in-flygrep-window) | ||
| - [FeedBack](#feedback) | ||
|
|
||
| <!-- vim-markdown-toc --> | ||
|
|
||
| ## Intro | ||
|
|
||
| _FlyGrep.vim_ is a vim/neovim plugin to run the searching tool asynchronously, and display the result on the fly. | ||
|
|
||
| ## Install | ||
|
|
||
| for dein.vim | ||
| Using [dein.vim](https://github.com/Shougo/dein.vim) | ||
|
|
||
| ```vim | ||
| call dein#add('wsdjeg/FlyGrep.vim') | ||
| ``` | ||
|
|
||
| for vim-plug | ||
| Using [vim-plug](https://github.com/junegunn/vim-plug) | ||
|
|
||
| ```vim | ||
| Plug 'wsdjeg/FlyGrep.vim' | ||
| ``` | ||
|
|
||
| ## usage | ||
| ## Usage | ||
|
|
||
| ### Command | ||
|
|
||
| This plugin provides a `:FlyGrep` command. | ||
|
|
||
| ``` | ||
| :FlyGrep | ||
| ``` | ||
|
|
||
| you also can define custom mapping, for example: | ||
| ### Key bindings in FlyGrep window | ||
|
|
||
| ```vim | ||
| nnoremap <Space>s/ :FlyGrep<cr> | ||
| ``` | ||
| | Key Bindings | Descriptions | | ||
| | ------------------ | --------------------------------------------- | | ||
| | Tab / Ctrl-j | move cursor to next item | | ||
| | Shift-Tab / Ctrl-K | move cursor to previous item | | ||
| | ScrollWheelDown | move cursor to next item | | ||
| | ScrollWheelUp | move cursor to previous item | | ||
| | Enter | open file at the cursor line | | ||
| | Ctrl-t | open item in new tab | | ||
| | LeftMouse | move cursor to mouse position | | ||
| | 2-LeftMouse | open file at the mouse position | | ||
| | Ctrl-f | start filter mode | | ||
| | Ctrl-v | open item in vertical split window | | ||
| | Ctrl-s | open item in split window | | ||
| | Ctrl-q | apply all items into quickfix | | ||
| | Ctrl-e | toggle fix-string mode | | ||
| | Ctrl-h | toggle display hidden files | | ||
| | Ctrl-r | read from register, need insert register name | | ||
| | Left / Right | move cursor to left or right | | ||
| | BackSpace | remove last character | | ||
| | Ctrl-w | remove the Word before the cursor | | ||
| | Ctrl-u | remove the Line before the cursor | | ||
| | Ctrl-k | remove the Line after the cursor | | ||
| | Ctrl-a / Home | Go to the beginning of the line | | ||
| | End | Go to the end of the line | | ||
|
|
||
| ## FeedBack | ||
|
|
||
| Key Binding | Description | ||
| -----------| ----------- | ||
| `SPC s /` | Searching in project on the fly with default tools | ||
|
|
||
| key binding in FlyGrep buffer: | ||
|
|
||
| Key Binding | Description | ||
| -----------| ----------- | ||
| `<Esc>` | close FlyGrep buffer | ||
| `<C-c>` | close FlyGrep buffer | ||
| `<Enter>` | open file at the cursor line | ||
| `<Tab>` | move cursor line down | ||
| `<C-j>` | move cursor line down | ||
| `<S-Tab>` | move cursor line up | ||
| `<C-k>` | move cursor line up | ||
| `<Bs>` | remove last character | ||
| `<C-w>` | remove the Word before the cursor | ||
| `<C-u>` | remove the Line before the cursor | ||
| `<C-k>` | remove the Line after the cursor | ||
| `<C-a>`/`<Home>` | Go to the beginning of the line | ||
| `<C-e>`/`<End>` | Go to the end of the line | ||
| The development of this plugin is in [`SpaceVim/bundle/FlyGrep`](https://github.com/SpaceVim/SpaceVim/tree/master/bundle/FlyGrep) directory. | ||
|
|
||
| If you encounter any bugs or have suggestions, please file an issue in the [issue tracker](https://github.com/SpaceVim/SpaceVim/issues) |