mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-02-02 23:00:04 +08:00
Update doc
This commit is contained in:
wsdjeg
parent
d9a5ea0ee1
commit
3500e18f01
@ -34,10 +34,12 @@ SpaceVim 是一个社区驱动的模块化 vim/neovim 配置集合，其中包
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
* [安装](#安装)
|
||||
* [更新](#更新)
|
||||
* [特性](#特性)
|
||||
* [文档](#文档)
|
||||
* [优雅的界面](#优雅的界面)
|
||||
* [主题](#主题)
|
||||
* [快捷键导航](#快捷键导航)
|
||||
* [Unite为主的工作平台](#unite为主的工作平台)
|
||||
* [模块化配置](#模块化配置)
|
||||
* [Denite/Unite为主的工作平台](#deniteunite为主的工作平台)
|
||||
* [自动补全](#自动补全)
|
||||
* [细致的tags管理](#细致的tags管理)
|
||||
* [快速](#快速)
|
||||
@ -90,7 +92,7 @@ Windows 下用户如果不方便编译，可以在qq群文件里面下载相应
|
||||
|
||||
可以通过 `:SPUpdate` 命令来更新spacevim 以及包含的插件，如果需要更新指定的插件，如：startuptime.vim，只需要执行 `:SPUpdate startuptime.vim`，也可以通过 `:SPUpdate SpaceVim` 来更新 SpaceVim.
|
||||
|
||||
## 特性
|
||||
## 文档
|
||||
|
||||
### 优雅的界面
|
||||
|
||||
@ -98,6 +100,28 @@ SpaceVim 集成了多种使用UI插件，如常用的文件树、语法树等插
|
||||
|
||||
|
||||
|
||||
#### 主题
|
||||
|
||||
SpaceVim 默认的颜色主题采用的是 [gruvbox](https://github.com/morhetz/gruvbox)。这一主题有深色和浅色两种。关于这一主题一些详细的配置可以阅读 <kbd>:h gruvbox</kbd>.
|
||||
|
||||
如果需要修改 SpaceVim 的主题，可以在 `~/.SpaceVim.d/init.vim` 中修改 `g:g:spacevim_colorscheme`。例如，使用 [vim-one with dark colorscheme](https://github.com/rakr/vim-one)
|
||||
|
||||
```vim
|
||||
let g:spacevim_colorscheme = 'one'
|
||||
let g:spacevim_colorscheme_bg = 'dark'
|
||||
```
|
||||
|
||||
| 快捷键 | 描述 |
|
||||
| ------------------ | -------------------------------------------------------------- |
|
||||
| <kbd>SPC T n</kbd> | 切换至下一个随机主题 |
|
||||
| <kbd>SPC T s</kbd> | 通过 Unite 选择主题 |
|
||||
|
||||
可以在[主题模块](http://spacevim.org/layers/colorscheme/)中查看 SpaceVim 支持的所有主题。
|
||||
|
||||
**注意**:
|
||||
|
||||
SpaceVim 在终端下默认使用了真色，因此使用之前需要确认下你的终端是否支持真色，可以阅读 [Colours in terminal](https://gist.github.com/XVilka/8346728) 了解根多关于真色的信息。
|
||||
|
||||
### 快捷键导航
|
||||
|
||||
SpaceVim 所有的快捷键都不需要去记忆，有强大的快捷键导航系统来提示每一个按键的具体功能，比如 Normal 模式下按下空格键，将出现如下提示：
|
||||
@ -112,18 +136,27 @@ SpaceVim 所有的快捷键都不需要去记忆，有强大的快捷键导航
|
||||
| `n` | 导航系统下一页 |
|
||||
| `p` | 导航系统前一页 |
|
||||
|
||||
### Unite为主的工作平台
|
||||
### 模块化配置
|
||||
|
||||
SpaceVim 是由多个独立模块组成的配置集合，针对不同的功能需求，设计了多个模块，用户在使用的时候只需要载入相应的模块即可。比如对于 Java 开发者，载入 `lang#java`、`autocomplete`、`checker`、`tags`模块即可配置出一个适合 Java 开发的 Vim 环境。
|
||||
|
||||
SpaceVim 支持的模：[http://spacevim.org/layers/](http://spacevim.org/layers/)
|
||||
|
||||
### Denite/Unite为主的工作平台
|
||||
|
||||
Unite 的快捷键前缀是`f`， 可以通过 `g:spacevim_unite_leader` 来设定，快捷键无需记忆，SpaceVim 有很好的快捷键辅助机制，如下是 Unite 的快捷键键图：
|
||||
|
||||
|
||||
|
||||
Denite 是新一代的插件，相比 Unite 速度更加快，安装也更加方便。 的快捷键前缀是`F`， 可以通过 `g:spacevim_denite_leader` 来设定。
|
||||
|
||||
### 自动补全
|
||||
|
||||
SpaceVim 采用最快补全引擎 deoplete, 该引擎不同与YouCompleteMe的主要一点是支持多源补全，而不单单是语义补全。 而且补全来源拓展非常方便。
|
||||
|
||||
### 细致的tags管理
|
||||
|
||||
|
||||
## 快速
|
||||
|
||||
SpaceVim 将从 ~/.SpaceVim.d/init.vim 和当前目录的 ./SpaceVim.d/init.vim 载入配置，并且更新 rtp，用户可以在 ~/.SpaceVim.d/ 和 .SpaceVim.d/ 这两个文件夹下编辑自己的脚本，和 SpaceVim 的配置文件。
|
||||
@ -193,6 +226,8 @@ let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'
|
||||
| `g:spacevim_sidebar_width` | 30 | 设置边栏宽度，文件树以及语法树 |
|
||||
| `g:spacevim_custom_plugins` | `[]` | 设置自定义插件 |
|
||||
|
||||
|
||||
|
||||
### 延伸阅读
|
||||
|
||||
#### Vim 8 新特新之旅
|
||||
|
||||
@ -6,131 +6,131 @@ title: "Documentation"
|
||||
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
* [Core Pillars](#core-pillars)
|
||||
* [Mnemonic](#mnemonic)
|
||||
* [Discoverable](#discoverable)
|
||||
* [Consistent](#consistent)
|
||||
* [Crowd-Configured](#crowd-configured)
|
||||
* [Mnemonic](#mnemonic)
|
||||
* [Discoverable](#discoverable)
|
||||
* [Consistent](#consistent)
|
||||
* [Crowd-Configured](#crowd-configured)
|
||||
* [Highlighted features](#highlighted-features)
|
||||
* [Screenshots](#screenshots)
|
||||
* [welcome page](#welcome-page)
|
||||
* [working flow](#working-flow)
|
||||
* [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)
|
||||
* [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)
|
||||
* [Configuration layers](#configuration-layers)
|
||||
* [Custom Configuration](#custom-configuration)
|
||||
* [Automatic Generation](#automatic-generation)
|
||||
* [Alternative directory](#alternative-directory)
|
||||
* [Automatic Generation](#automatic-generation)
|
||||
* [Alternative directory](#alternative-directory)
|
||||
* [Concepts](#concepts)
|
||||
* [Transient-states](#transient-states)
|
||||
* [Transient-states](#transient-states)
|
||||
* [Awesome ui](#awesome-ui)
|
||||
* [Colorschemes](#colorschemes)
|
||||
* [Font](#font)
|
||||
* [UI Toggles](#ui-toggles)
|
||||
* [Statusline && tabline](#statusline--tabline)
|
||||
* [statusline](#statusline)
|
||||
* [tabline](#tabline)
|
||||
* [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)
|
||||
* [Commenting](#commenting)
|
||||
* [Multi-Encodings](#multi-encodings)
|
||||
* [Errors handling](#errors-handling)
|
||||
* [Managing projects](#managing-projects)
|
||||
* [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)
|
||||
* [Commenting](#commenting)
|
||||
* [Multi-Encodings](#multi-encodings)
|
||||
* [Errors handling](#errors-handling)
|
||||
* [Managing projects](#managing-projects)
|
||||
* [Achievements](#achievements)
|
||||
* [issues](#issues)
|
||||
* [Stars, forks and watchers](#stars-forks-and-watchers)
|
||||
* [issues](#issues)
|
||||
* [Stars, forks and watchers](#stars-forks-and-watchers)
|
||||
* [Features](#features)
|
||||
* [Awesome ui](#awesome-ui-1)
|
||||
* [Mnemonic key bindings](#mnemonic-key-bindings)
|
||||
* [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)
|
||||
* [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)
|
||||
* [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)
|
||||
* [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)
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user