mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-23 04:00:03 +08:00
docs(flygrep): update flygrep readme
This commit is contained in:
parent
aa03777a73
commit
4ba1672b75
@ -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/img/build-with-SpaceVim.svg)](https://spacevim.org)
|
||||
[![GPLv3 License](https://img.spacevim.org/license-GPLv3-blue.svg)](LICENSE)
|
||||
|
||||
![searching project](https://img.spacevim.org/35278709-7856ed62-0010-11e8-8b1e-e6cc6374b0dc.gif)
|
||||
|
||||
<!-- 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 |
|
||||
|
||||
Key Binding | Description
|
||||
-----------| -----------
|
||||
`SPC s /` | Searching in project on the fly with default tools
|
||||
## FeedBack
|
||||
|
||||
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)
|
||||
|
Loading…
Reference in New Issue
Block a user