Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-03-13 02:05:40 +08:00
Code Issues Projects Releases Wiki Activity

Update fuzzy find layer doc (#2737)

Browse Source 
* Update doc

* Update doc
This commit is contained in:
Wang Shidong 2019-04-11 11:29:14 +08:00 committed by GitHub
parent ed51e65daf
commit 301037d9f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 41 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
autoload/SpaceVim/layers/fzf.vim
View File

@ -140,7 +140,9 @@ function! s:defind_fuzzy_finder() abort
\ 'Definition: ' . s:file . ':' . lnum,
\ ]
\ ]
nnoremap <silent> <Leader>f<Space> :FzfMenu CustomKeyMaps<CR>
let lnum = expand('<slnum>') + s:unite_lnum - 4
let g:_spacevim_mappings.f['[SPC]'] = ['FzfMenu CustomKeyMaps',
\ 'fuzzy find custom key bindings',
\ [
@ -149,6 +151,17 @@ function! s:defind_fuzzy_finder() abort
\ 'Definition: ' . s:file . ':' . lnum,
\ ]
\ ]
nnoremap <silent> <Leader>fp :<C-u>FzfMenu AddedPlugins<CR>
let lnum = expand('<slnum>') + s:unite_lnum - 4
let g:_spacevim_mappings.f.p = ['FzfMenu AddedPlugins',
\ 'fuzzy find vim packages',
\ [
\ '[Leader f p] is to fuzzy find vim packages installed in SpaceVim',
\ '',
\ 'Definition: ' . s:file . ':' . lnum,
\ ]
\ ]
endfunction
command! FzfColors call <SID>colors()

37
docs/documentation.md
View File

@ -765,16 +765,24 @@ endfunction
### Fuzzy finder
SpaceVim provides five kinds of fuzzy finder, each of them is configured in a layer(`unite`, `denite`, `leaderf`, `ctrlp` and `fzf` layer).
SpaceVim provides five fuzzy find tools, each of them is configured in a layer(`unite`, `denite`, `leaderf`, `ctrlp` and `fzf` layer).
These layers have the same key bindings and features. But they need different dependencies.
Users only need to load one of these layers, they will be able to get these features.
for example, load the denite layer:
```toml
[[layers]]
name = "denite"
```
**Key bindings**
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f p` | Fuzzy find menu:AddedPlugins |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |
@ -784,20 +792,21 @@ Users only need to load one of these layers, they will be able to get these feat
| `<Leader> f q` | Fuzzy find quick fix |
| `<Leader> f r` | Resumes Unite window |
But in current version of SpaceVim, leaderf/ctrlp and fzf layer have not be finished.
**Differences between these layers**
| Feature | unite | denite | leaderf | ctrlp | fzf |
| ------------------ | ----- | ------ | ------- | ----- | --- |
| menu CustomKeyMaps | yes | yes | no | no | no |
| register | yes | yes | no | yes | yes |
| file | yes | yes | yes | yes | yes |
| yank history | yes | yes | no | no | yes |
| jump | yes | yes | no | yes | yes |
| location list | yes | yes | no | no | yes |
| outline | yes | yes | yes | yes | yes |
| message | yes | yes | no | no | yes |
| quickfix list | yes | yes | no | yes | yes |
| resume windows | yes | yes | no | no | no |
| Feature | denite | unite | leaderf | ctrlp | fzf |
| ------------------ | :----: | :---: | :-----: | :---: | --- |
| CustomKeyMaps menu | yes | yes | no | no | no |
| AddedPlugins menu | yes | yes | no | no | no |
| register | yes | yes | no | yes | yes |
| file | yes | yes | yes | yes | yes |
| yank history | yes | yes | no | no | yes |
| jump | yes | yes | no | yes | yes |
| location list | yes | yes | no | no | yes |
| outline | yes | yes | yes | yes | yes |
| message | yes | yes | no | no | yes |
| quickfix list | yes | yes | no | yes | yes |
| resume windows | yes | yes | no | no | no |
**Key bindings within fuzzy finder buffer**

6
docs/layers/denite.md
View File

@ -24,19 +24,19 @@ To use this configuration layer, add it to your configuration file.
```toml
[[layers]]
name = "denite"
name = "denite"
```
## Configuration
SpaceVim use `F` as the default customized key bindings prefix for denite layer.
SpaceVim use `<Leader> f` as the default key bindings prefix for denite layer.
## Key bindings
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f p` | Fuzzy find menu:AddedPlugins |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |

4
docs/layers/fzf.md
View File

@ -31,6 +31,7 @@ name = "fzf"
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f p` | Fuzzy find menu:AddedPlugins |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |
@ -38,5 +39,4 @@ name = "fzf"
| `<Leader> f m` | Fuzzy find output messages |
| `<Leader> f o` | Fuzzy find outline |
| `<Leader> f q` | Fuzzy find quick fix |
| `<Leader> f r` | Resumes Unite window |
| `<Leader> b b` | List all buffers |
| `SPC b b` | List all buffers |