mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-24 05:40:05 +08:00
207 lines
9.3 KiB
Markdown
207 lines
9.3 KiB
Markdown
---
|
||
title: "SpaceVim 中文手册"
|
||
---
|
||
|
||
# SpaceVim 中文手册
|
||
|
||
[![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev)](https://travis-ci.org/SpaceVim/SpaceVim)
|
||
![Version](https://img.shields.io/badge/version-0.5.0--dev-FF00CC.svg)
|
||
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
|
||
[![Doc](https://img.shields.io/badge/doc-%3Ah%20SpaceVim-orange.svg?style=flat-square)](https://github.com/SpaceVim/SpaceVim/blob/dev/doc/SpaceVim.txt)
|
||
[![QQ](https://img.shields.io/badge/QQ群-121056965-blue.svg)](https://jq.qq.com/?_wv=1027&k=43DB6SG)
|
||
[![Gitter](https://badges.gitter.im/SpaceVim/SpaceVim.svg)](https://gitter.im/SpaceVim/SpaceVim?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||
[![Facebook](https://img.shields.io/badge/FaceBook-SpaceVim-blue.svg)](https://www.facebook.com/SpaceVim)
|
||
|
||
[![GitHub watchers](https://img.shields.io/github/watchers/SpaceVim/SpaceVim.svg?style=social&label=Watch)](https://github.com/SpaceVim/SpaceVim)
|
||
[![GitHub stars](https://img.shields.io/github/stars/SpaceVim/SpaceVim.svg?style=social&label=Star)](https://github.com/SpaceVim/SpaceVim)
|
||
[![GitHub forks](https://img.shields.io/github/forks/SpaceVim/SpaceVim.svg?style=social&label=Fork)](https://github.com/SpaceVim/SpaceVim)
|
||
[![Twitter Follow](https://img.shields.io/twitter/follow/SpaceVim.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/SpaceVim)
|
||
|
||
![welcome-page](https://cloud.githubusercontent.com/assets/13142418/26402270/28ad72b8-40bc-11e7-945e-003f41e057be.png)
|
||
|
||
项 目 主 页: <https://spacevim.org>
|
||
|
||
Github 地址 : <https://github.com/SpaceVim/SpaceVim>
|
||
|
||
SpaceVim 是一个社区驱动的模块化 vim/neovim 配置集合,其中包含了多种功能模块,并且针对 neovim 做了功能优化。spacevim 有多种功能模块可供用户选择,针对不同语言选择特定的模块,就可以配置出一个适合特定语言开发的环境。
|
||
|
||
使用过程中遇到问题或者有什么功能需求可以在 github 提交 issue,这将更容易被关注和修复。我们也欢迎喜欢 vim/neovim 的用户加入我们的 QQ 群,一起讨论 vim 相关的技巧,[点击加入Vim/SpaceVim用户群](https://jq.qq.com/?_wv=1027&k=43zWPlT)。
|
||
|
||
以下是近几周的开发汇总:
|
||
|
||
[![Throughput Graph](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg)](https://github.com/SpaceVim/SpaceVim/pulse)
|
||
|
||
<!-- vim-markdown-toc GFM -->
|
||
* [安装](#安装)
|
||
* [更新](#更新)
|
||
* [特性](#特性)
|
||
* [优雅的界面](#优雅的界面)
|
||
* [快捷键导航](#快捷键导航)
|
||
* [Unite为主的工作平台](#unite为主的工作平台)
|
||
* [自动补全](#自动补全)
|
||
* [细致的tags管理](#细致的tags管理)
|
||
* [快速](#快速)
|
||
* [SpaceVim选项](#spacevim选项)
|
||
* [延伸阅读](#延伸阅读)
|
||
* [Vim 8 新特新之旅](#vim-8-新特新之旅)
|
||
|
||
<!-- vim-markdown-toc -->
|
||
|
||
## 安装
|
||
|
||
**Linux 或 Mac 下 SpaceVim的安装非常简单,只需要执行以下命令即可:**
|
||
|
||
```sh
|
||
curl -sLf https://spacevim.org/install.sh | bash
|
||
```
|
||
|
||
想要获取更多的自定义的安装方式,请参考:
|
||
|
||
```sh
|
||
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
|
||
```
|
||
|
||
SpaceVim是一种模块化配置,可以运行在vim或者neovim上,关于vim以及neovim的安装,请参考以下链接:
|
||
|
||
[安装neovim](https://github.com/neovim/neovim/wiki/Installing-Neovim)
|
||
|
||
[从源码编译vim](https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source)
|
||
|
||
**windows系统下的安装步骤:**
|
||
|
||
Windows 下 vim 用户只需要将本仓库克隆成用户 HOME 目录下的 vimfiles 即可,打开 CMD 默认的目录默认即为 HOME 目录,只需要执行如下命令即可:
|
||
|
||
git clone https://github.com/SpaceVim/SpaceVim.git vimfiles
|
||
|
||
Windows 下 neovim 用户 需要将本仓库克隆成用户 HOME 目录下的 AppData\\Local\\nvim,想要获取跟多关于 neovim 安装相关的知识,可以访问 neovim 的 wiki, wiki 写的非常详细。打开 CMD 初始目录默认一般即为 HOME 目录,只需要执行如下命令即可:
|
||
|
||
git clone https://github.com/SpaceVim/SpaceVim.git AppData\Local\nvim
|
||
|
||
**字体**
|
||
|
||
SpaceVim 默认启用了Powerline 字体,默认的的字体文件是:[DejaVu Sans Mono](https://github.com/wsdjeg/DotFiles/tree/master/fonts), Windows 用户直接下载下来右键安装即可。
|
||
|
||
**vimproc.dll**
|
||
|
||
Windows 下用户如果不方便编译,可以在qq群文件里面下载相应的dll文件放到vimproc
|
||
的lib目录,默认是 `~/.cache/vimfiles/repos/github.com/Shougo/vimproc.vim/lib/`
|
||
|
||
## 更新
|
||
|
||
可以通过 `:SPUpdate` 命令来更新spacevim 以及包含的插件,如果需要更新指定的插件,如:startuptime.vim,只需要执行 `:SPUpdate startuptime.vim`,也可以通过 `:SPUpdate SpaceVim` 来更新 SpaceVim.
|
||
|
||
## 特性
|
||
|
||
### 优雅的界面
|
||
|
||
SpaceVim 集成了多种使用UI插件,如常用的文件树、语法树等插件,配色主题默认采用的是 gruvbox。
|
||
|
||
![UI](https://cloud.githubusercontent.com/assets/13142418/22506638/84705532-e8bc-11e6-8b72-edbdaf08426b.png)
|
||
|
||
### 快捷键导航
|
||
|
||
SpaceVim 所有的快捷键都不需要去记忆,有强大的快捷键导航系统来提示每一个按键的具体功能,比如 Normal 模式下按下空格键,将出现如下提示:
|
||
|
||
![mapping-guide](https://cloud.githubusercontent.com/assets/13142418/25778673/ae8c3168-3337-11e7-8536-ee78d59e5a9c.png)
|
||
|
||
这一导航提示将所有以空格为前缀的快捷键分组展示,比如 `b` 是所以 buffer 相关的快捷键, `p` 是所有工程管理相关的快捷键。在导航模式下按下 `<C-h>` 你将在状态栏上看见相应的帮助信息,按键介绍如下:
|
||
|
||
| 按键 | 描述 |
|
||
| --- | ------- |
|
||
| `u` | 撤销前一按键 |
|
||
| `n` | 导航系统下一页 |
|
||
| `p` | 导航系统前一页 |
|
||
|
||
### Unite为主的工作平台
|
||
|
||
Unite 的快捷键前缀是`f`, 可以通过 `g:spacevim_unite_leader` 来设定,快捷键无需记忆,SpaceVim 有很好的快捷键辅助机制,如下是 Unite 的快捷键键图:
|
||
|
||
![unite](https://cloud.githubusercontent.com/assets/13142418/23955542/26fd5348-09d5-11e7-8253-1f43991439b0.png)
|
||
|
||
### 自动补全
|
||
|
||
SpaceVim 采用最快补全引擎 deoplete, 该引擎不同与YouCompleteMe的主要一点是支持多源补全,而不单单是语义补全。 而且补全来源拓展非常方便。
|
||
|
||
### 细致的tags管理
|
||
|
||
## 快速
|
||
|
||
SpaceVim 将从 ~/.SpaceVim.d/init.vim 和当前目录的 ./SpaceVim.d/init.vim 载入配置,并且更新 rtp,用户可以在 ~/.SpaceVim.d/ 和 .SpaceVim.d/ 这两个文件夹下编辑自己的脚本,和 SpaceVim 的配置文件。
|
||
|
||
示例:
|
||
|
||
```vim
|
||
" Here are some basic customizations,
|
||
" please refer to the ~/.SpaceVim.d/init.vim
|
||
" file for all possible options:
|
||
let g:spacevim_default_indent = 3
|
||
let g:spacevim_max_column = 80
|
||
|
||
" Change the default directory where all miscellaneous persistent files go.
|
||
" By default it is ~/.cache/vimfiles/.
|
||
let g:spacevim_plugin_bundle_dir = '~/.cache/vimfiles/'
|
||
|
||
" set SpaceVim colorscheme
|
||
let g:spacevim_colorscheme = 'jellybeans'
|
||
|
||
" Set plugin manager, you want to use, default is dein.vim
|
||
let g:spacevim_plugin_manager = 'dein' " neobundle or dein or vim-plug
|
||
|
||
" use space as `<Leader>`
|
||
let mapleader = "\<space>"
|
||
|
||
" Set windows shortcut leader [Window], default is `s`
|
||
let g:spacevim_windows_leader = 's'
|
||
|
||
" Set unite work flow shortcut leader [Unite], default is `f`
|
||
let g:spacevim_unite_leader = 'f'
|
||
|
||
" By default, language specific plugins are not loaded. This can be changed
|
||
" with the following, then the plugins for go development will be loaded.
|
||
call SpaceVim#layers#load('lang#go')
|
||
|
||
" loaded ui layer
|
||
call SpaceVim#layers#load('ui')
|
||
|
||
" If there is a particular plugin you don't like, you can define this
|
||
" variable to disable them entirely:
|
||
let g:spacevim_disabled_plugins=[
|
||
\ ['junegunn/fzf.vim'],
|
||
\ ]
|
||
|
||
" If you want to add some custom plugins, use these options:
|
||
let g:spacevim_custom_plugins = [
|
||
\ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}],
|
||
\ ['wsdjeg/GitHub.vim'],
|
||
\ ]
|
||
|
||
" set the guifont
|
||
let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'
|
||
```
|
||
|
||
### SpaceVim选项
|
||
|
||
| 选项名称 | 默认值 | 描述 |
|
||
| ---------------------------------- | :-----------------: | --------------- |
|
||
| `g:spacevim_default_indent` | 2 | 对齐空格 |
|
||
| `g:spacevim_enable_guicolors` | 1 | 启用/禁用终端使用真色彩 |
|
||
| `g:spacevim_windows_leader` | `s` | 窗口管理快捷键前缀 |
|
||
| `g:spacevim_unite_leader` | `f` | Unite快捷键前缀 |
|
||
| `g:spacevim_plugin_bundle_dir` | `~/.cache/vimfiles` | 默认插件缓存位置 |
|
||
| `g:spacevim_realtime_leader_guide` | 0 | 启用/禁用实时快捷键提示 |
|
||
| `g:spacevim_guifont` | '' | 设置SpaceVim字体 |
|
||
| `g:spacevim_sidebar_width` | 30 | 设置边栏宽度,文件树以及语法树 |
|
||
| `g:spacevim_custom_plugins` | `[]` | 设置自定义插件 |
|
||
|
||
### 延伸阅读
|
||
|
||
#### Vim 8 新特新之旅
|
||
|
||
<ul>
|
||
{% for post in site.categories.tutorials_cn %}
|
||
<li>
|
||
<a href="{{ post.url }}">{{ post.title }}</a>
|
||
</li>
|
||
{% endfor %}
|
||
</ul>
|