diff --git a/docs/documentation.md b/docs/documentation.md index c4ea2a9dd..19c850cba 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -7,140 +7,140 @@ description: "General documentation about how to using SpaceVim, including the q -- [Core Pillars](#core-pillars) - - [Mnemonic](#mnemonic) - - [Discoverable](#discoverable) - - [Consistent](#consistent) - - [Crowd-Configured](#crowd-configured) -- [Highlighted features](#highlighted-features) -- [Screenshots](#screenshots) - - [welcome page](#welcome-page) - - [working flow](#working-flow) -- [Who can benefit from this?](#who-can-benefit-from-this) -- [Update and Rollback](#update-and-rollback) - - [Update SpaceVim itself](#update-spacevim-itself) - - [Automatic Updates](#automatic-updates) - - [Updating from the SpaceVim Buffer](#updating-from-the-spacevim-buffer) - - [Updating Manually with git](#updating-manually-with-git) - - [Update plugins](#update-plugins) - - [Get SpaceVim log](#get-spacevim-log) -- [Configuration layers](#configuration-layers) - - [Purpose](#purpose) - - [Structure](#structure) -- [Custom Configuration](#custom-configuration) - - [Automatic Generation](#automatic-generation) - - [Alternative directory](#alternative-directory) -- [Concepts](#concepts) - - [Transient-states](#transient-states) -- [Awesome ui](#awesome-ui) - - [Colorschemes](#colorschemes) - - [Font](#font) - - [UI Toggles](#ui-toggles) - - [Statusline && tabline](#statusline--tabline) - - [statusline](#statusline) - - [tabline](#tabline) -- [Manual](#manual) - - [Completion](#completion) - - [Unite/Denite](#unitedenite) - - [Mappings within unite/denite buffer](#mappings-within-unitedenite-buffer) - - [Discovering](#discovering) - - [Mappings](#mappings) - - [Mappings guide](#mappings-guide) - - [Unide/Denite describe key bindings](#unidedenite-describe-key-bindings) - - [Getting help](#getting-help) - - [Available layers](#available-layers) - - [Available plugins in SpaceVim](#available-plugins-in-spacevim) - - [New packages from ELPA repositories](#new-packages-from-elpa-repositories) - - [Toggles](#toggles) - - [Navigating](#navigating) - - [Point/Cursor](#pointcursor) - - [Vim motions with vim-easymotion](#vim-motions-with-vim-easymotion) - - [quick-jump-link mode (TODO)](#quick-jump-link-mode-todo) - - [Unimpaired bindings](#unimpaired-bindings) - - [Jumping, Joining and Splitting](#jumping-joining-and-splitting) - - [Jumping](#jumping) - - [Joining and splitting](#joining-and-splitting) - - [Window manipulation](#window-manipulation) - - [Window manipulation key bindings](#window-manipulation-key-bindings) - - [Buffers and Files](#buffers-and-files) - - [Buffers manipulation key bindings](#buffers-manipulation-key-bindings) - - [Create a new empty buffer](#create-a-new-empty-buffer) - - [Special Buffers](#special-buffers) - - [Files manipulations key bindings](#files-manipulations-key-bindings) - - [Vim and SpaceVim files](#vim-and-spacevim-files) - - [File tree](#file-tree) - - [File tree navigation](#file-tree-navigation) - - [Open file with file tree.](#open-file-with-file-tree) - - [Commands starting with `g`](#commands-starting-with-g) - - [Commands starting with `z`](#commands-starting-with-z) - - [Auto-saving](#auto-saving) - - [Searching](#searching) - - [With an external tool](#with-an-external-tool) - - [Useful key bindings](#useful-key-bindings) - - [Searching in current file](#searching-in-current-file) - - [Searching in all loaded buffers](#searching-in-all-loaded-buffers) - - [Searching in an arbitrary directory](#searching-in-an-arbitrary-directory) - - [Searching in a project](#searching-in-a-project) - - [Background searching in a project](#background-searching-in-a-project) - - [Searching the web](#searching-the-web) - - [Searching on the fly](#searching-on-the-fly) - - [Persistent highlighting](#persistent-highlighting) - - [Editing](#editing) - - [Paste text](#paste-text) - - [Auto-indent pasted text](#auto-indent-pasted-text) - - [Text manipulation commands](#text-manipulation-commands) - - [Text insertion commands](#text-insertion-commands) - - [Increase/Decrease numbers](#increasedecrease-numbers) - - [Commenting](#commenting) - - [Multi-Encodings](#multi-encodings) - - [Errors handling](#errors-handling) - - [Managing projects](#managing-projects) - - [Searching files in project](#searching-files-in-project) -- [EditorConfig](#editorconfig) -- [Vim Server](#vim-server) - - [Connecting to the Vim server](#connecting-to-the-vim-server) -- [Achievements](#achievements) - - [issues](#issues) - - [Stars, forks and watchers](#stars-forks-and-watchers) -- [Features](#features) - - [Awesome ui](#awesome-ui-1) - - [Mnemonic key bindings](#mnemonic-key-bindings) -- [Language specific mode](#language-specific-mode) -- [Key Mapping](#key-mapping) - - [c/c++ support](#cc-support) - - [go support](#go-support) - - [python support](#python-support) -- [Neovim centric - Dark powered mode of SpaceVim.](#neovim-centric---dark-powered-mode-of-spacevim) -- [Modular configuration](#modular-configuration) -- [Multiple leader mode](#multiple-leader-mode) - - [Global origin vim leader](#global-origin-vim-leader) - - [Local origin vim leader](#local-origin-vim-leader) - - [Windows function leader](#windows-function-leader) - - [Unite work flow leader](#unite-work-flow-leader) -- [Unite centric work-flow](#unite-centric-work-flow) - - [Plugin Highlights](#plugin-highlights) - - [Non Lazy-Loaded Plugins](#non-lazy-loaded-plugins) - - [Lazy-Loaded Plugins](#lazy-loaded-plugins) - - [Language](#language) - - [Commands](#commands) - - [Commands](#commands-1) - - [Completion](#completion-1) - - [Unite](#unite) - - [Operators & Text Objects](#operators--text-objects) - - [Custom Key bindings](#custom-key-bindings) - - [File Operations](#file-operations) - - [Editor UI](#editor-ui) - - [Window Management](#window-management) - - [Native functions](#native-functions) - - [Plugin: Unite](#plugin-unite) - - [Plugin: neocomplete](#plugin-neocomplete) - - [Plugin: NERD Commenter](#plugin-nerd-commenter) - - [Plugin: Goyo and Limelight](#plugin-goyo-and-limelight) - - [Plugin: ChooseWin](#plugin-choosewin) - - [Plugin: Bookmarks](#plugin-bookmarks) - - [Plugin: Gina/Gita](#plugin-ginagita) - - [Plugin: vim-signify](#plugin-vim-signify) - - [Misc Plugins](#misc-plugins) +* [Core Pillars](#core-pillars) + * [Mnemonic](#mnemonic) + * [Discoverable](#discoverable) + * [Consistent](#consistent) + * [Crowd-Configured](#crowd-configured) +* [Highlighted features](#highlighted-features) +* [Screenshots](#screenshots) + * [welcome page](#welcome-page) + * [working flow](#working-flow) +* [Who can benefit from this?](#who-can-benefit-from-this) +* [Update and Rollback](#update-and-rollback) + * [Update SpaceVim itself](#update-spacevim-itself) + * [Automatic Updates](#automatic-updates) + * [Updating from the SpaceVim Buffer](#updating-from-the-spacevim-buffer) + * [Updating Manually with git](#updating-manually-with-git) + * [Update plugins](#update-plugins) + * [Get SpaceVim log](#get-spacevim-log) +* [Configuration layers](#configuration-layers) + * [Purpose](#purpose) + * [Structure](#structure) +* [Custom Configuration](#custom-configuration) + * [Automatic Generation](#automatic-generation) + * [Alternative directory](#alternative-directory) +* [Concepts](#concepts) + * [Transient-states](#transient-states) +* [Awesome ui](#awesome-ui) + * [Colorschemes](#colorschemes) + * [Font](#font) + * [UI Toggles](#ui-toggles) + * [Statusline && tabline](#statusline--tabline) + * [statusline](#statusline) + * [tabline](#tabline) +* [Manual](#manual) + * [Completion](#completion) + * [Unite/Denite](#unitedenite) + * [Mappings within unite/denite buffer](#mappings-within-unitedenite-buffer) + * [Discovering](#discovering) + * [Mappings](#mappings) + * [Mappings guide](#mappings-guide) + * [Unide/Denite describe key bindings](#unidedenite-describe-key-bindings) + * [Getting help](#getting-help) + * [Available layers](#available-layers) + * [Available plugins in SpaceVim](#available-plugins-in-spacevim) + * [New packages from ELPA repositories](#new-packages-from-elpa-repositories) + * [Toggles](#toggles) + * [Navigating](#navigating) + * [Point/Cursor](#pointcursor) + * [Vim motions with vim-easymotion](#vim-motions-with-vim-easymotion) + * [quick-jump-link mode (TODO)](#quick-jump-link-mode-todo) + * [Unimpaired bindings](#unimpaired-bindings) + * [Jumping, Joining and Splitting](#jumping-joining-and-splitting) + * [Jumping](#jumping) + * [Joining and splitting](#joining-and-splitting) + * [Window manipulation](#window-manipulation) + * [Window manipulation key bindings](#window-manipulation-key-bindings) + * [Buffers and Files](#buffers-and-files) + * [Buffers manipulation key bindings](#buffers-manipulation-key-bindings) + * [Create a new empty buffer](#create-a-new-empty-buffer) + * [Special Buffers](#special-buffers) + * [Files manipulations key bindings](#files-manipulations-key-bindings) + * [Vim and SpaceVim files](#vim-and-spacevim-files) + * [File tree](#file-tree) + * [File tree navigation](#file-tree-navigation) + * [Open file with file tree.](#open-file-with-file-tree) + * [Commands starting with `g`](#commands-starting-with-g) + * [Commands starting with `z`](#commands-starting-with-z) + * [Auto-saving](#auto-saving) + * [Searching](#searching) + * [With an external tool](#with-an-external-tool) + * [Useful key bindings](#useful-key-bindings) + * [Searching in current file](#searching-in-current-file) + * [Searching in all loaded buffers](#searching-in-all-loaded-buffers) + * [Searching in an arbitrary directory](#searching-in-an-arbitrary-directory) + * [Searching in a project](#searching-in-a-project) + * [Background searching in a project](#background-searching-in-a-project) + * [Searching the web](#searching-the-web) + * [Searching on the fly](#searching-on-the-fly) + * [Persistent highlighting](#persistent-highlighting) + * [Editing](#editing) + * [Paste text](#paste-text) + * [Auto-indent pasted text](#auto-indent-pasted-text) + * [Text manipulation commands](#text-manipulation-commands) + * [Text insertion commands](#text-insertion-commands) + * [Increase/Decrease numbers](#increasedecrease-numbers) + * [Commenting](#commenting) + * [Multi-Encodings](#multi-encodings) + * [Errors handling](#errors-handling) + * [Managing projects](#managing-projects) + * [Searching files in project](#searching-files-in-project) +* [EditorConfig](#editorconfig) +* [Vim Server](#vim-server) + * [Connecting to the Vim server](#connecting-to-the-vim-server) +* [Achievements](#achievements) + * [issues](#issues) + * [Stars, forks and watchers](#stars-forks-and-watchers) +* [Features](#features) + * [Awesome ui](#awesome-ui-1) + * [Mnemonic key bindings](#mnemonic-key-bindings) +* [Language specific mode](#language-specific-mode) +* [Key Mapping](#key-mapping) + * [c/c++ support](#cc-support) + * [go support](#go-support) + * [python support](#python-support) +* [Neovim centric - Dark powered mode of SpaceVim.](#neovim-centric---dark-powered-mode-of-spacevim) +* [Modular configuration](#modular-configuration) +* [Multiple leader mode](#multiple-leader-mode) + * [Global origin vim leader](#global-origin-vim-leader) + * [Local origin vim leader](#local-origin-vim-leader) + * [Windows function leader](#windows-function-leader) + * [Unite work flow leader](#unite-work-flow-leader) +* [Unite centric work-flow](#unite-centric-work-flow) + * [Plugin Highlights](#plugin-highlights) + * [Non Lazy-Loaded Plugins](#non-lazy-loaded-plugins) + * [Lazy-Loaded Plugins](#lazy-loaded-plugins) + * [Language](#language) + * [Commands](#commands) + * [Commands](#commands-1) + * [Completion](#completion-1) + * [Unite](#unite) + * [Operators & Text Objects](#operators--text-objects) + * [Custom Key bindings](#custom-key-bindings) + * [File Operations](#file-operations) + * [Editor UI](#editor-ui) + * [Window Management](#window-management) + * [Native functions](#native-functions) + * [Plugin: Unite](#plugin-unite) + * [Plugin: neocomplete](#plugin-neocomplete) + * [Plugin: NERD Commenter](#plugin-nerd-commenter) + * [Plugin: Goyo and Limelight](#plugin-goyo-and-limelight) + * [Plugin: ChooseWin](#plugin-choosewin) + * [Plugin: Bookmarks](#plugin-bookmarks) + * [Plugin: Gina/Gita](#plugin-ginagita) + * [Plugin: vim-signify](#plugin-vim-signify) + * [Misc Plugins](#misc-plugins) @@ -1795,15 +1795,15 @@ Unite work flow leader can only be used in normal mode. Unite leader need unite | `s`+`t` | Normal | Open new tab (:tabnew) | | `s`+`o` | Normal | Close other windows (:only) | | `s`+`x` | Normal | Remove buffer, leave blank window | -| `s`+`q` | Normal | Closes current buffer (:close) | -| `s`+`Q` | Normal | Removes 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` | Normal | 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` | Normal | Close current buffer (:close) | | `Tab` | Normal | Next window or tab | | `Shift`+`Tab` | Normal | Previous window or tab | | ``+`sv` | Normal | Split with previous buffer | -| ``+`sg` | Normal | Vertical split with previous buffer | +| ``+`sg` | Normal | Vertically split with previous buffer | SpaceVim has mapped normal q as smart buffer close, the normal func of q -can be get by `` q r +can be get by q r ##### Native functions