Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-02 22:30:04 +08:00
Code Issues Projects Releases Wiki Activity

Format key notations (#1940)

Browse Source
This commit is contained in:
Wang Shidong 2018-08-04 14:31:00 +08:00 committed by GitHub
parent d09bfba5e1
commit 9d1a6f8de8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
22 changed files with 315 additions and 300 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
autoload/SpaceVim.vim
View File

@ -962,9 +962,9 @@ endfunction
" `<leader>+<c-f>`.
" <
"
" 4. How to use `<space>` as `<leader>`?
" 4. How to use `<Space>` as `<Leader>`?
" >
" Add `let mapleader = "\<space>"` to `~/.SpaceVim.d/init.vim`
" Add `let mapleader = "\<Space>"` to `~/.SpaceVim.d/init.vim`
" <
""

4
autoload/SpaceVim/layers/core.vim
View File

@ -44,8 +44,8 @@ function! SpaceVim#layers#core#config() abort
let g:matchup_matchparen_status_offscreen = 0
" Unimpaired bindings
" Quickly add empty lines
nnoremap <silent> [<space> :<c-u>put! =repeat(nr2char(10), v:count1)<cr>
nnoremap <silent> ]<space> :<c-u>put =repeat(nr2char(10), v:count1)<cr>
nnoremap <silent> [<Space> :<c-u>put! =repeat(nr2char(10), v:count1)<cr>
nnoremap <silent> ]<Space> :<c-u>put =repeat(nr2char(10), v:count1)<cr>
"]e or [e move current line ,count can be useed
nnoremap <silent>[e :<c-u>execute 'move -1-'. v:count1<cr>

2
autoload/SpaceVim/layers/incsearch.vim
View File

@ -27,7 +27,7 @@
" z/ n incsearch fuzzy /
" z? n incsearch fuzzy ?
" zg? n incsearch fuzzy g?
" <space>/ n incsearch easymotion
" <Space>/ n incsearch easymotion
" <
let s:filename = expand('<sfile>:~')

4
autoload/SpaceVim/layers/lang/lisp.vim
View File

@ -17,7 +17,7 @@ endfunction
function! SpaceVim#layers#lang#lisp#config() abort
let g:vlime_default_mappings = {
\ 'lisp': [
\ ['i', '<space>', '<space><c-r>=VlimeKey("space")<cr>'],
\ ['i', '<Space>', '<Space><c-r>=VlimeKey("space")<cr>'],
\ ['i', '<cr>', '<cr><c-r>=VlimeKey("cr")<cr>'],
\ ['i', '<tab>', '<c-r>=VlimeKey("tab")<cr>'],
\
@ -62,7 +62,7 @@ function! SpaceVim#layers#lang#lisp#config() abort
\ ],
\
\ 'inspector': [
\ ['n', ['<cr>', '<space>'], ':call vlime#ui#inspector#InspectorSelect()<cr>'],
\ ['n', ['<cr>', '<Space>'], ':call vlime#ui#inspector#InspectorSelect()<cr>'],
\ ['n', ['<c-n>', '<tab>'], ':call vlime#ui#inspector#NextField(v:true)<cr>'],
\ ['n', '<c-p>', ':call vlime#ui#inspector#NextField(v:false)<cr>'],
\ ['n', 'p', ':call vlime#ui#inspector#InspectorPop()<cr>'],

6
autoload/SpaceVim/layers/ui.vim
View File

@ -27,7 +27,7 @@ function! SpaceVim#layers#ui#plugins() abort
endfunction
function! SpaceVim#layers#ui#config() abort
if g:spacevim_colorscheme_bg == 'dark'
if g:spacevim_colorscheme_bg ==# 'dark'
let g:indentLine_color_term = get(g:, 'indentLine_color_term', 239)
let g:indentLine_color_gui = get(g:, 'indentLine_color_gui', '#504945')
else
@ -88,6 +88,10 @@ function! SpaceVim#layers#ui#config() abort
call SpaceVim#mapping#space#def('nnoremap', ['t', 'S'], 'call call('
\ . string(s:_function('s:toggle_spell_check')) . ', [])',
\ 'toggle spell checker', 1)
call SpaceVim#mapping#space#def('nnoremap', ['t', 'l'], 'setlocal list!',
\ 'toggle hidden listchars', 1)
call SpaceVim#mapping#space#def('nnoremap', ['t', 'W'], 'setlocal wrap!',
\ 'toggle wrap line', 1)
call SpaceVim#mapping#space#def('nnoremap', ['t', 'w'], 'call call('
\ . string(s:_function('s:toggle_whitespace')) . ', [])',
\ 'toggle the whitespace', 1)

2
autoload/SpaceVim/mapping/leader.vim
View File

@ -165,7 +165,7 @@ function! SpaceVim#mapping#leader#defindDeniteLeader(key) abort
\ -buffer-name=register register<CR>
let g:_spacevim_mappings_denite.e = ['Denite register', 'denite register']
nnoremap <silent> [denite]<Space> :Denite menu:CustomKeyMaps<CR>
let g:_spacevim_mappings_denite['<space>'] = ['Denite menu:CustomKeyMaps',
let g:_spacevim_mappings_denite['<Space>'] = ['Denite menu:CustomKeyMaps',
\ 'denite customkeymaps']
endif
endfunction

6
doc/SpaceVim.cnx
View File

@ -762,7 +762,7 @@ mappings
z/ n incsearch fuzzy /
z? n incsearch fuzzy ?
zg? n incsearch fuzzy g?
<space>/ n incsearch easymotion
<Space>/ n incsearch easymotion
<
==============================================================================
@ -1220,10 +1220,10 @@ FAQ *SpaceVim-faq*
`<leader>+<c-f>`.
<
4. How to use `<space>` as `<leader>`?
4. How to use `<Space>` as `<Leader>`?
>
Add `let mapleader = "\<space>"` to `~/.SpaceVim.d/init.vim`
Add `let mapleader = "\<Space>"` to `~/.SpaceVim.d/init.vim`
<

8
doc/SpaceVim.txt
View File

@ -266,7 +266,7 @@ this feature, or you can set to another char.
CONFIGURATION *SpaceVim-config*
If you still want to use `~/.SpaceVim.d/init.vim` as configuration file,
please check bellowing options.
please take a look at the following options.
*g:spacevim_version*
@ -907,7 +907,7 @@ mappings
z/ n incsearch fuzzy /
z? n incsearch fuzzy ?
zg? n incsearch fuzzy g?
<space>/ n incsearch easymotion
<Space>/ n incsearch easymotion
<
==============================================================================
@ -1409,10 +1409,10 @@ FAQ *SpaceVim-faq*
`<leader>+<c-f>`.
<
4. How to use `<space>` as `<leader>`?
4. How to use `<Space>` as `<Leader>`?
>
Add `let mapleader = "\<space>"` to `~/.SpaceVim.d/init.vim`
Add `let mapleader = "\<Space>"` to `~/.SpaceVim.d/init.vim`
<
==============================================================================

2
docs/cn/documentation.md
View File

@ -688,7 +688,7 @@ features.
| Key bindings | Description |
| -------------------- | ----------------------------- |
| `<Leader> f <space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f f` | Fuzzy find file |
| `<Leader> f h` | Fuzzy find history/yank |

2
docs/cn/layers/ctrlp.md
View File

@ -36,7 +36,7 @@ ctrlp 模块默认并为启用，如果需要启用该模块，需要在配置
| 按键 | 描述 |
| -------------------- | ------------------------------ |
| `<Leader> f <space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f <Space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f e` | 模糊搜索寄存器 |
| `<Leader> f h` | 模糊搜索 history/yank |
| `<Leader> f j` | 模糊搜索 jump, change |

2
docs/cn/layers/denite.md
View File

@ -35,7 +35,7 @@ denite 模块默认并为启用，如果需要启用该模块，需要在配置
| 按键 | 描述 |
| -------------------- | ------------------------------ |
| `<Leader> f <space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f <Space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f e` | 模糊搜索寄存器 |
| `<Leader> f h` | 模糊搜索 history/yank |
| `<Leader> f j` | 模糊搜索 jump, change |

2
docs/cn/layers/fzf.md
View File

@ -35,7 +35,7 @@ fzf 模块默认并为启用，如果需要启用该模块，需要在配置文
| 按键 | 描述 |
| -------------------- | ------------------------------ |
| `<Leader> f <space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f <Space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f e` | 模糊搜索寄存器 |
| `<Leader> f h` | 模糊搜索 history/yank |
| `<Leader> f j` | 模糊搜索 jump, change |

2
docs/cn/layers/leaderf.md
View File

@ -35,7 +35,7 @@ leaderf 模块默认并为启用，如果需要启用该模块，需要在配置
| 按键 | 描述 |
| -------------------- | ------------------------------ |
| `<Leader> f <space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f <Space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f e` | 模糊搜索寄存器 |
| `<Leader> f h` | 模糊搜索 history/yank |
| `<Leader> f j` | 模糊搜索 jump, change |

2
docs/cn/layers/unite.md
View File

@ -35,7 +35,7 @@ unite 模块默认并为启用，如果需要启用该模块，需要在配置
| 按键 | 描述 |
| -------------------- | ------------------------------ |
| `<Leader> f <space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f <Space>` | 模糊查找快捷键，并执行该快捷键 |
| `<Leader> f e` | 模糊搜索寄存器 |
| `<Leader> f h` | 模糊搜索 history/yank |
| `<Leader> f j` | 模糊搜索 jump, change |

10
docs/conventions.md
View File

@ -32,7 +32,7 @@ description: "conventions of contributing to SpaceVim, including the coding styl
- [Whitespace](#whitespace)
- [Line Continuations](#line-continuations)
- [Naming](#naming)
- [Markdown style guide](#markdown-style-guide)
- [Key notations](#key-notations)
- [Thanks:](#thanks)
<!-- vim-markdown-toc -->
@ -286,7 +286,13 @@ Always prefix variables with their scope.
- b: changes the variable semantics; use it when you want buffer-local semantics.
- l: and v: should be used for consistency, future proofing, and to avoid subtle bugs. They are not strictly required. Add them in new code but don’t go out of your way to add them elsewhere.
## Markdown style guide
## Key notations
- use capital case and angle brackets for keyboard button: `<Down>`, `<Up>`
- use uppercase for custom leader: `SPC`, `WIN`, `UNITE`, `DENITE`
- use space as delimiter for key sequences: `SPC t w`, `<Leader> f f`
- use `/` for alternative sequences: `<Tab>` / `<C-n>`
- Use `Ctrl-e` instead of `<C-e>` in documentation
## Thanks:

294
docs/documentation.md
View File

@ -117,18 +117,13 @@ Community-driven configuration provides curated packages tuned by power users an
## Highlighted features
- **Great documentation:** access documentation in SpaceVim with
`:h SpaceVim`.
- **Great documentation:** access documentation in SpaceVim with `:h SpaceVim`.
- **Minimalistic and nice graphical UI:** you'll love the awesome UI and its useful features.
- **Keep your fingers on the home row:** for quicker editing with support for QWERTY and BEPO layouts.
- **Mnemonic key bindings:** commands have mnemonic prefixes like
`[Window]` for all the window and buffer commands or `[Unite]` for the
unite work flow commands.
- **Mnemonic key bindings:** commands have mnemonic prefixes like `[WIN]` for all the window and buffer commands or `[Unite]` for the unite work flow commands.
- **Fast boot time:** Lazy-load 90% of plugins with [dein.vim]
- **Lower the risk of RSI:** by heavily using the space bar instead of modifiers.
- **Batteries included:** discover hundreds of ready-to-use packages nicely
organised in configuration layers following a set of
[conventions](http://spacevim.org/conventions/).
- **Batteries included:** discover hundreds of ready-to-use packages nicely organised in configuration layers following a set of [conventions](http://spacevim.org/conventions/).
- **Neovim centric:** Dark powered mode of SpaceVim
## Screenshots
@ -246,7 +241,7 @@ The bootstrap functions should be placed to the `autoload` directory in `runtime
```vim
func! myspacevim#before() abort
let g:neomake_enabled_c_makers = ['clang']
nnoremap jk <esc>
nnoremap jk <Esc>
endf
func! myspacevim#after() abort
@ -273,7 +268,7 @@ the option is `g:spacevim_enable_language_specific_leader`, default value is 1.
the option is `g:spacevim_windows_smartclose`, default value is `q`. If you still prefer the origin function of `q`, you can use an empty string to disable this feature.
- The `Ctrl + a` binding on the command line auto-completes variable names, but in SpaceVim it moves to the cursor to the beginning of the command.
- The `Ctrl-a` binding on the command line auto-completes variable names, but in SpaceVim it moves to the cursor to the beginning of the command.
[Send a PR](http://spacevim.org/development/) to add the differences you found in this section.
@ -616,124 +611,133 @@ You can also use `SPC t t` to open the tab manager windows.
key bindings within tab manager windows:
| Key Binding | Description |
| ------------ | ----------------------------------------- |
| ----------------- | ----------------------------------------- |
| `o` | Close or expand tab windows. |
| `r` | Rename the tab under the cursor. |
| `n` | Create new named tab below the cursor tab |
| `N` | Create new tab below the cursor tab |
| `x` | Delete the tab |
| `<C-S-Up>` | Move tab backward |
| `<C-S-Down>` | Move tab forward |
| `Ctrl-Shift-Up` | Move tab backward |
| `Ctrl-Shift-Down` | Move tab forward |
| `<Enter>` | Jump to windows under the cursor. |
## General Key bindings
### Window manager
Windows manager key bindings can only be used in normal mode. The default leader is `s`, you can
can change it via `g:spacevim_windows_leader`
Windows manager key bindings can only be used in normal mode. The default leader `[WIN]` is `s`, you
can change it via `windows_leader` option:
```toml
[options]
windows_leader = "s"
```
| Key bindings | Description |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `q` | Smart buffer close |
| `s`+`p` | Split nicely |
| `s`+`v` | :split |
| `s`+`g` | :vsplit |
| `s`+`t` | Open new tab (:tabnew) |
| `s`+`o` | Close other windows (:only) |
| `s`+`x` | Remove buffer, leave blank window |
| `s`+`q` | Remove current buffer, left buffer in the tabline will be displayed. If there is no buffer on the left, the right buffer will be displayed; if this is the last buffer in the tabline, then an empty buffer will be displayed. |
| `s`+`Q` | Close current buffer (:close) |
| `Tab` | Next window or tab |
| `Shift`+`Tab` | Previous window or tab |
| `<leader>`+`sv` | Split with previous buffer |
| `<leader>`+`sg` | Vertically split with previous buffer |
| `WIN p` | Split nicely |
| `WIN v` | :split |
| `WIN g` | :vsplit |
| `WIN t` | Open new tab (:tabnew) |
| `WIN o` | Close other windows (:only) |
| `WIN x` | Remove buffer, leave blank window |
| `WIN q` | Remove current buffer, left buffer in the tabline will be displayed. If there is no buffer on the left, the right buffer will be displayed; if this is the last buffer in the tabline, then an empty buffer will be displayed. |
| `WIN Q` | Close current buffer (:close) |
| `<Tab>` | Next window or tab |
| `Shift-Tab` | Previous window or tab |
| `<Leader> s v` | Split with previous buffer |
| `<Leader> s g` | Vertically split with previous buffer |
SpaceVim has mapped normal `q` as smart buffer close, the normal func of `q`
can be get by `<leader> q r`
can be get by `<Leader> q r`, if you want to disable this feature, you can use `vimcompatible` mode.
| Key | Mode | Action |
| --------------------- | :-----------: | ------------------------------------------------------------------------------ |
| `<leader>`+`y` | visual | Copy selection to X11 clipboard ("+y) |
| `Ctrl`+`c` | Normal | Copy full path of current buffer to X11 clipboard |
| `<leader>`+`Ctrl`+`c` | Normal | Copy github.com url of current buffer to X11 clipboard(if it is a github repo) |
| `<leader>`+`Ctrl`+`l` | Normal/visual | Copy github.com url of current lines to X11 clipboard(if it is a github repo) |
| `<leader>`+`p` | Normal/visual | Paste selection from X11 clipboard ("+p) |
| `Ctrl`+`f` | Normal | Smart page forward (C-f/C-d) |
| `Ctrl`+`b` | Normal | Smart page backwards (C-b/C-u) |
| `Ctrl`+`e` | Normal | Smart scroll down (3C-e/j) |
| `Ctrl`+`y` | Normal | Smart scroll up (3C-y/k) |
| `Ctrl`+`q` | Normal | `Ctrl`+`w` |
| `Ctrl`+`x` | Normal | Switch buffer and placement |
| `Up,Down` | Normal | Smart up and down |
| ----------------- | :-----------: | ------------------------------------------------------------------------------ |
| `<Leader> y` | visual | Copy selection to X11 clipboard ("+y) |
| `Ctrl-c` | Normal | Copy full path of current buffer to X11 clipboard |
| `<Leader> Ctrl-c` | Normal | Copy github.com url of current buffer to X11 clipboard(if it is a github repo) |
| `<Leader> Ctrl-l` | Normal/visual | Copy github.com url of current lines to X11 clipboard(if it is a github repo) |
| `<Leader> p` | Normal/visual | Paste selection from X11 clipboard ("+p) |
| `Ctrl-f` | Normal | Smart page forward (C-f/C-d) |
| `Ctrl-b` | Normal | Smart page backwards (C-b/C-u) |
| `Ctrl-e` | Normal | Smart scroll down (3C-e/j) |
| `Ctrl-y` | Normal | Smart scroll up (3C-y/k) |
| `Ctrl-q` | Normal | `Ctrl`+`w` |
| `Ctrl-x` | Normal | Switch buffer and placement |
| `<Up>`, `<Down>` | Normal | Smart up and down |
| `}` | Normal | After paragraph motion go to first non-blank char (}^) |
| `<` | Visual/Normal | Indent to left and re-select |
| `>` | Visual/Normal | Indent to right and re-select |
| `Tab` | Visual | Indent to right and re-select |
| `Shift`+`Tab` | Visual | Indent to left and re-select |
| `<Tab>` | Visual | Indent to right and re-select |
| `Shift-Tab` | Visual | Indent to left and re-select |
| `g p` | Normal | Select last paste |
| `Q` / `g Q` | Normal | Disable EX-mode (<Nop>) |
| `Ctrl`+`a` | Command | Navigation in command line |
| `Ctrl`+`b` | Command | Move cursor backward in command line |
| `Ctrl`+`f` | Command | Move cursor forward in command line |
| `Ctrl-a` | Command | Navigation in command line |
| `Ctrl-b` | Command | Move cursor backward in command line |
| `Ctrl-f` | Command | Move cursor forward in command line |
### File Operations
| Key | Mode | Action |
| --------------- | :-------------------: | ------------------------------------------ |
| `<leader>`+`cd` | Normal | Switch to the directory of the open buffer |
| `<leader>`+`w` | Normal/visual | Write (:w) |
| `Ctrl`+`s` | Normal/visual/Command | Write (:w) |
| `:w!!` | Command | Write as root (%!sudo tee > /dev/null %) |
| Key binding | Description |
| -------------- | ------------------------------------------ |
| `<Leader> c d` | Switch to the directory of the open buffer |
| `SPC f s` | Write (:w) |
| `Ctrl-s` | Write (:w) |
| `SPC f W` | Write as root (need sudo layer) |
### Editor UI
| Key | Mode | Action |
| ----------------------- | :-----------: | ---------------------------------------------------------------- |
| `F2` | _All_ | Toggle tagbar |
| `F3` | _All_ | Toggle Vimfiler |
| `<leader>` + num | Normal | Jump to the buffer with the num index |
| `<Alt>` + num | Normal | Jump to the buffer with the num index, this only works in neovim |
| `<Alt>` + `h`/`<Left>` | Normal | Jump to left buffer in the tabline, this only works in neovim |
| `<Alt>` + `l`/`<Right>` | Normal | Jump to Right buffer in the tabline, this only works in neovim |
| `<leader>`+`ts` | Normal | Toggle spell-checker (:setlocal spell!) |
| `<leader>`+`tn` | Normal | Toggle line numbers (:setlocal nonumber!) |
| `<leader>`+`tl` | Normal | Toggle hidden characters (:setlocal nolist!) |
| `<leader>`+`th` | Normal | Toggle highlighted search (:set hlsearch!) |
| `<leader>`+`tw` | Normal | Toggle wrap (:setlocal wrap! breakindent!) |
| `g0` | Normal | Go to first tab (:tabfirst) |
| `g$` | Normal | Go to last tab (:tablast) |
| `gr` | Normal | Go to previous tab (:tabprevious) |
| `Ctrl`+`<Dow>` | Normal | Move to split below (<C-w>j) |
| `Ctrl`+`<Up>` | Normal | Move to upper split (<C-w>k) |
| `Ctrl`+`<Left>` | Normal | Move to left split (<C-w>h) |
| `Ctrl`+`<Right>` | Normal | Move to right split (<C-w>l) |
| `*` | Visual | Search selection forwards |
| `#` | Visual | Search selection backwards |
| `,`+`Space` | Normal | Remove all spaces at EOL |
| `Ctrl`+`r` | Visual | Replace selection |
| `<leader>`+`lj` | Normal | Next on location list |
| `<leader>`+`lk` | Normal | Previous on location list |
| `<leader>`+`S` | Normal/visual | Source selection |
| Key binding | Description |
| --------------------- | ---------------------------------------------------------------- |
| `<F2>` | Toggle tagbar |
| `<F3>` | Toggle Vimfiler |
| `<Leader> [1-9]` | Jump to the buffer with the num index |
| `Alt-[1-9]` | Jump to the buffer with the num index, this only works in neovim |
| `Alt-h` / `Alt-Left` | Jump to left buffer in the tabline, this only works in neovim |
| `Alt-l` / `Alt-Right` | Jump to Right buffer in the tabline, this only works in neovim |
| `SPC t S` | Toggle spell checker |
| `SPC t n` | Toggle line number and relativenumber |
| `SPC t l` | Toggle hidden characters (:setlocal nolist!) |
| `SPC t W` | Toggle wrap (:setlocal wrap! breakindent!) |
| `g 0` | Go to first tab (:tabfirst) |
| `g $` | Go to last tab (:tablast) |
| `g r` | Go to previous tab (:tabprevious) |
| `Ctrl-Down` | Move to split below (`Ctrl-w j`) |
| `Ctrl-Up` | Move to upper split (`Ctrl-w k`) |
| `Ctrl-Left` | Move to left split (`Ctrl-w h`) |
| `Ctrl-Right` | Move to right split (`Ctrl-w l`) |
| `*` | Search selection forwards |
| `#` | Search selection backwards |
| `, <Space>` | Remove all spaces at EOL |
| `Ctrl-r` | Replace selection in visual mode |
### Native functions
| Key | Mode | Action |
| ------------------ | :----: | -------------------------------- |
| `<leader>` + `qr` | Normal | Same as native `q` |
| `<leader>` + `qr/` | Normal | Same as native `q/`, open cmdwin |
| `<leader>` + `qr?` | Normal | Same as native `q?`, open cmdwin |
| `<leader>` + `qr:` | Normal | Same as native `q:`, open cmdwin |
| ---------------- | :----: | --------------------------------- |
| `<Leader> q r` | Normal | Same as native `q` |
| `<Leader> q r /` | Normal | Same as native `q /`, open cmdwin |
| `<Leader> q r ?` | Normal | Same as native `q ?`, open cmdwin |
| `<Leader> q r :` | Normal | Same as native `q :`, open cmdwin |
### Bookmarks management
| Key | Mode | Action |
| ------- | :----: | ------------------------------- |
| `m`+`a` | Normal | Show list of all bookmarks |
| `m`+`m` | Normal | Toggle bookmark in current line |
| `m`+`n` | Normal | Jump to next bookmark |
| `m`+`p` | Normal | Jump to previous bookmark |
| `m`+`i` | Normal | Annotate bookmark |
Bookmarks manager are included in `tools` layer, to use following key bindings, you need to enable
`tools` layer:
```toml
[[layers]]
name = "tools"
```
| Key binding | Description |
| ----------- | ------------------------------- |
| `m a` | Show list of all bookmarks |
| `m m` | Toggle bookmark in current line |
| `m n` | Jump to next bookmark |
| `m p` | Jump to previous bookmark |
| `m i` | Annotate bookmark |
As SpaceVim use above bookmarks mappings, so you can not use `a`, `m`, `n`, `p` or `i` registers to mark current position, but other registers should works will. if you really need to use these registers, you can add `nnoremap <leader>m m` to your custom configuration, then you use use `a` registers via `\ma`
@ -749,7 +753,7 @@ features.
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f f` | Fuzzy find file |
| `<Leader> f h` | Fuzzy find history/yank |
@ -777,28 +781,28 @@ But in current version of SpaceVim, leaderf/ctrlp and fzf layer has not be finis
**Key bindings within fuzzy finder buffer**
| key bindings | Mode | description |
| --------------------- | ------ | ----------------------------------------- |
| `Tab`/`<C-j>` | - | Select next line |
| `Shift + Tab`/`<C-k>` | - | Select previous line |
| `jk` | Insert | Leave Insert mode (Only for denite/unite) |
| `Ctrl`+`w` | Insert | Delete backward path |
| `Enter` | - | Run default action |
| `Ctrl`+`s` | - | Open in a split |
| `Ctrl`+`v` | - | Open in a vertical split |
| `Ctrl`+`t` | - | Open in a new tab |
| `Ctrl`+`g` | - | Exit unite |
| key bindings | description |
| ---------------------- | ----------------------------------------- |
| `<Tab>` / `Ctrl-j` | Select next line |
| `Shift-Tab` / `Ctrl-k` | Select previous line |
| `j k` | Leave Insert mode (Only for denite/unite) |
| `Ctrl-w` | Delete backward path |
| `<Enter>` | Run default action |
| `Ctrl-s` | Open in a split |
| `Ctrl-v` | Open in a vertical split |
| `Ctrl-t` | Open in a new tab |
| `Ctrl-g` | Exit unite |
**Denite/Unite normal mode key bindings**
| key bindings | Mode | description |
| ---------------- | ------------- | ------------------------------------ |
| `Ctrl`+`h/k/l/r` | Normal | Un-map |
| `Ctrl`+`l` | Normal | Redraw |
| `Tab` | Normal | Select actions |
| `Space` | Normal | Toggle mark current candidate, up |
| -------------- | ------------- | ------------------------------------ |
| `Ctrl-h/k/l/r` | Normal | Un-map |
| `Ctrl-l` | Normal | Redraw |
| `<Tab>` | Normal | Select actions |
| `<Space>` | Normal | Toggle mark current candidate, up |
| `r` | Normal | Replace ('search' profile) or rename |
| `Ctrl`+`z` | Normal/insert | Toggle transpose window |
| `Ctrl-z` | Normal/insert | Toggle transpose window |
The above key bindings only are part of fuzzy finder layers, please read the layer's documentation.
@ -809,15 +813,15 @@ The above key bindings only are part of fuzzy finder layers, please read the lay
**Mappings guide**
A guide buffer is displayed each time the prefix key is pressed in normal mode. It lists the available key bindings and their short description.
The prefix can be `[SPC]`, `[Window]`, `[denite]`, `<leader>` and `[unite]`.
The prefix can be `[SPC]`, `[WIN]` and `<Leader>`.
The default key of these prefix is:
| Prefix name | custom option and default value | description |
| ----------- | --------------------------------- | ----------------------------------- |
| ----------- | ------------------------------- | ----------------------------------- |
| `[SPC]` | NONE / `<Space>` | default mapping prefix of SpaceVim |
| `[Window]` | `g:spacevim_windows_leader` / `s` | window mapping prefix of SpaceVim |
| `<leader>` | default vim leader | default leader prefix of vim/neovim |
| `[WIN]` | `windows_leader` / `s` | window mapping prefix of SpaceVim |
| `<Leader>` | default vim leader | default leader prefix of vim/neovim |
By default the guide buffer will be displayed 1000ms after the key has been pressed. You can change the delay by setting `'timeoutlen'` option to your liking (the value is in milliseconds).
@ -827,7 +831,7 @@ for example, after pressing `<Space>` in normal mode, you will see :
this guide show you all the available key bindings begin with `[SPC]`, you can type `b` for all the buffer mappings, `p` for project mappings, etc.
after pressing `<C-h>` in guide buffer, you will get paging and help info in the statusline.
after pressing `Ctrl-h` in guide buffer, you will get paging and help info in the statusline.
| key | description |
| --- | ----------------------------- |
@ -1045,8 +1049,8 @@ Buffer manipulation commands (start with `b`):
| `SPC u SPC b d` | kill the current buffer and window (does not delete the visited file) (TODO) |
| `SPC b D` | kill a visible buffer using vim-choosewin |
| `SPC u SPC b D` | kill a visible buffer and its window using ace-window(TODO) |
| `SPC b C-d` | kill other buffers |
| `SPC b C-D` | kill buffers using a regular expression(TODO) |
| `SPC b Ctrl-d` | kill other buffers |
| `SPC b Ctrl-D` | kill buffers using a regular expression(TODO) |
| `SPC b e` | erase the content of the buffer (ask for confirmation) |
| `SPC b h` | open _SpaceVim_ home buffer |
| `SPC b n` | switch to next buffer avoiding special buffers |
@ -1109,7 +1113,9 @@ Convenient key bindings are located under the prefix `SPC f v` to quickly naviga
#### File tree
SpaceVim use vimfiler as the default file tree, and the default key binding is `F3`, and SpaceVim also provide `SPC f t` and `SPC f T` to open the file tree. to change the file explore to nerdtree:
SpaceVim use vimfiler as the default file tree, and the default key binding is `<F3>`, and
SpaceVim also provide `SPC f t` and `SPC f T` to open the file tree.
to change the file explore to nerdtree:
```toml
# the default value is vimfiler
@ -1127,16 +1133,12 @@ here is any picture for this feature:
Navigation is centered on the `hjkl` keys with the hope of providing a fast navigation experience like in [vifm](https://github.com/vifm):
| Key Binding | Description |
| ------------------------------ | ------------------------------------------------- |
| `<F3>` or `SPC f t` | Toggle file explorer |
| **Within _file tree_ buffers** | |
| `<Left>` or `h` | go to parent node and collapse expanded directory |
| `<Down>` or `j` | select next file or directory |
| `<Up>` or `k` | select previous file or directory |
| `<Right>` or `l` | open selected file or expand directory |
| `Ctrl`+`j` | Un-map |
| `Ctrl`+`l` | Un-map |
| `E` | Un-map |
| ------------------ | ------------------------------------------------- |
| `<F3>` / `SPC f t` | Toggle file explorer |
| `<Left>` / `h` | go to parent node and collapse expanded directory |
| `<Down>` / `j` | select next file or directory |
| `<Up>` / `k` | select previous file or directory |
| `<Right>` / `l` | open selected file or expand directory |
| `N` | Create new file under corsor |
| `y y` | Copy file full path to system clipboard |
| `y Y` | Copy file to system clipboard |
@ -1150,7 +1152,7 @@ Navigation is centered on the `hjkl` keys with the hope of providing a fast navi
| `g x` | Execute with vimfiler associated |
| `'` | Toggle mark current line |
| `V` | Clear all marks |
| `Ctrl`+`r` | Redraw |
| `Ctrl-r` | Redraw |
##### Open file with file tree.
@ -1164,7 +1166,8 @@ If there is only one file buffer opened, a file is opened in the active window,
### Commands starting with `g`
after pressing prefix `g` in normal mode, if you do not remember the mappings, you will see the guide which will tell you the functional of all mappings starting with `g`.
after pressing prefix `g` in normal mode, if you do not remember the mappings, you will see the guide
which will tell you the functional of all mappings starting with `g`.
| Key Binding | Description |
| ----------- | ----------------------------------------------- |
@ -1212,11 +1215,12 @@ after pressing prefix `g` in normal mode, if you do not remember the mappings, y
| `g u` | make motion text lowercase |
| `g ~` | swap case for Nmove text |
| `g <End>` | go to rightmost character |
| `g<C-G>` | show cursor info |
| `g Ctrl-g` | show cursor info |
### Commands starting with `z`
after pressing prefix `z` in normal mode, if you do not remember the mappings, you will see the guide which will tell you the functional of all mappings starting with `z`.
after pressing prefix `z` in normal mode, if you do not remember the mappings, you will see the guide
which will tell you the functional of all mappings starting with `z`.
| Key Binding | Description |
| ----------- | -------------------------------------------- |
@ -1224,7 +1228,7 @@ after pressing prefix `z` in normal mode, if you do not remember the mappings, y
| `z +` | cursor to screen top line N |
| `z -` | cursor to screen bottom line N |
| `z .` | cursor line to center |
| `z<CR>` | cursor line to top |
| `z <Enter>` | cursor line to top |
| `z =` | spelling suggestions |
| `z A` | toggle folds recursively |
| `z C` | close folds recursively |
@ -1439,17 +1443,17 @@ Background search keyword in a project, when searching done, the count will be s
key binding in FlyGrep buffer:
| Key Binding | Description |
| ---------------- | --------------------------------- |
| ------------------- | --------------------------------- |
| `<Esc>` | close FlyGrep buffer |
| `<Enter>` | open file at the cursor line |
| `<Tab>` | move cursor line down |
| `<S-Tab>` | 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 |
| `Shift-Tab` | move cursor line up |
| `<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 |
| `Ctrl-e` / `<End>` | Go to the end of the line |
#### Persistent highlighting
@ -1486,7 +1490,7 @@ In highlight symbol transient state:
| `N`/`p` | go to previous occurrence |
| `b` | search occurrence in all buffers |
| `/` | search occurrence in whole project |
| `Tab` | toggle highlight current occurrence |
| `<Tab>` | toggle highlight current occurrence |
| `r` | change range (function, display area, whole buffer) |
| `R` | go to home occurrence (reset position to starting occurrence) |
| Any other key | leave the navigation transient state |
@ -1638,11 +1642,11 @@ The default color for iedit is `red`/`green` which is based on the current color
| Key Binding | Description |
| ----------- | ------------------------------ |
| `Esc` | go back to `iedit-Normal` mode |
| `<Esc>` | go back to `iedit-Normal` mode |
| `<Left>` | Move cursor to left |
| `<Right>` | Move cursor to right |
| `<C-w>` | delete words before cursor |
| `<C-K>` | delete words after cursor |
| `Ctrl-w` | delete words before cursor |
| `Ctrl-k` | delete words after cursor |
##### Examples

2
docs/layers/ctrlp.md
View File

@ -30,7 +30,7 @@ name = "ctrlp"
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |

2
docs/layers/denite.md
View File

@ -36,7 +36,7 @@ SpaceVim use `F` as the default customized key bindings prefix for denite layer.
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |

2
docs/layers/fzf.md
View File

@ -30,7 +30,7 @@ name = "fzf"
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |

2
docs/layers/leaderf.md
View File

@ -26,7 +26,7 @@ SpaceVim use `F` as the default customized key bindings prefix for denite layer.
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |

2
docs/layers/unite.md
View File

@ -36,7 +36,7 @@ This is a fuzzy finder layer for SpaceVim, and it is based on unite.vim. In Spac
| Key bindings | Discription |
| -------------------- | ----------------------------- |
| `<Leader> f <space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f <Space>` | Fuzzy find menu:CustomKeyMaps |
| `<Leader> f e` | Fuzzy find register |
| `<Leader> f h` | Fuzzy find history/yank |
| `<Leader> f j` | Fuzzy find jump, change |

1
wiki/en/Following-HEAD.md
View File

@ -71,6 +71,7 @@ The next release is v0.9.0.
- Update doc for debug upstream plugins ([#1981](https://github.com/SpaceVim/SpaceVim/pull/1981))
- Update doc windows key bindings ([#1995](https://github.com/SpaceVim/SpaceVim/pull/1995))
- Add doc for sudo layer ([#2011](https://github.com/SpaceVim/SpaceVim/pull/2011))
- Update key notations ([#1940](https://github.com/SpaceVim/SpaceVim/pull/1940))
### Others