2017-02-25 15:27:15 +08:00
[](https://spacevim.org)
2017-10-07 22:57:35 +08:00
[Wiki ](https://github.com/SpaceVim/SpaceVim/wiki ) \|
2020-02-20 12:07:32 +08:00
[Quick start guide ](https://spacevim.org/quick-start-guide/ ) \|
2018-08-16 21:21:53 +08:00
[Documentation ](https://spacevim.org/documentation/ ) \|
2017-10-07 22:57:35 +08:00
[Community ](https://spacevim.org/community/ ) \|
2018-08-16 21:21:53 +08:00
[Sponsors ](https://spacevim.org/sponsors/ ) \|
2020-02-20 12:07:32 +08:00
[Twitter ](https://twitter.com/SpaceVim ) \|
2017-10-07 22:57:35 +08:00
[Gitter **Chat** ](https://gitter.im/SpaceVim/SpaceVim ) \|
2018-08-11 18:41:20 +08:00
[中文官网 ](https://spacevim.org/cn/ )
2017-01-10 00:27:52 +08:00
2018-01-20 15:45:48 +08:00
[](https://travis-ci.org/SpaceVim/SpaceVim)
[](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/master)
2020-08-04 22:24:37 +08:00
[](https://hub.docker.com/r/spacevim/spacevim/)
2018-01-20 15:45:48 +08:00
[](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master)
2020-08-02 16:10:27 +08:00
2018-02-15 22:25:03 +08:00
[](LICENSE)
2017-05-01 20:36:41 +08:00
[](doc/SpaceVim.txt)
2017-02-05 10:03:28 +08:00
2018-09-29 17:35:11 +08:00
## About SpaceVim
2018-12-23 12:13:43 +08:00
2019-01-16 23:34:39 +08:00
SpaceVim is a community-driven modular Vim distribution. It manages collections
of plugins in layers, which help to collect related packages together to provide IDE-like features.
2018-07-02 20:09:46 +08:00
SpaceVim is not just a vimrc but an ultimate Vim configuration, It contains many built-in features.
2017-01-04 21:04:42 +08:00
2020-08-01 23:16:10 +08:00
2017-02-25 16:57:35 +08:00
2020-08-01 23:16:10 +08:00
The last release is v1.5.0, check out [following-HEAD ](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD ) page for what happened since last release.
2018-07-08 19:02:45 +08:00
2018-09-29 17:35:11 +08:00
## Instructions
2018-08-16 21:21:53 +08:00
2018-09-29 17:35:11 +08:00
**See the followings below for more information:**
- [Quick Start Guide ](https://spacevim.org/quick-start-guide/ )
- [Documentation ](https://spacevim.org/documentation/ )
- [Available Layers ](https://spacevim.org/layers/ )
If you have any questions about SpaceVim, please follow the [Getting Help Guide ](https://github.com/SpaceVim/SpaceVim/wiki/Getting-help ).
2017-05-30 15:27:03 +08:00
2017-12-10 19:57:48 +08:00
<!-- vim - markdown - toc GFM -->
2018-02-20 22:02:00 +08:00
- [New Features ](#new-features )
2017-12-10 19:57:48 +08:00
- [Project layout ](#project-layout )
- [Support SpaceVim ](#support-spacevim )
- [Credits & Thanks ](#credits--thanks )
<!-- vim - markdown - toc -->
2018-02-20 22:02:00 +08:00
### New Features
This is a list of latest features implemented in SpaceVim:
2018-01-27 01:07:02 +08:00
2018-04-23 21:21:29 +08:00
**Use toml as default configuration**
2019-01-16 23:34:39 +08:00
Here is an example for using toml as SpaceVim config:
2018-04-23 21:21:29 +08:00
```toml
2019-01-22 14:07:48 +08:00
# This is basic configuration example for SpaceVim.
2018-04-23 21:21:29 +08:00
2019-01-22 14:07:48 +08:00
# All SpaceVim options below [options] snippet.
2018-04-23 21:21:29 +08:00
[options]
2019-01-22 14:07:48 +08:00
# Set SpaceVim theme. By default colorscheme layer is not loaded.
# If you want to use more colorschemes, please load the colorscheme
# layer.
2018-04-23 21:21:29 +08:00
colorscheme = "gruvbox"
2018-09-26 21:52:28 +08:00
colorscheme_bg = "dark"
2018-04-23 21:21:29 +08:00
# Disable guicolors in basic mode, many terminal do not support 24bit
# true colors
2018-06-03 20:38:01 +08:00
enable_guicolors = false
2018-04-23 21:21:29 +08:00
# Disable statusline separator, if you want to use other value, please
# install nerd fonts
statusline_separator = "nil"
2018-06-03 20:38:01 +08:00
statusline_inactive_separator = "bar"
2018-04-23 21:21:29 +08:00
buffer_index_type = 4
2018-06-03 20:38:01 +08:00
windows_index_type = 3
2019-06-02 11:59:43 +08:00
enable_tabline_ft_icon = false
2018-07-08 19:02:45 +08:00
enable_statusline_mode = false
2018-06-03 20:38:01 +08:00
statusline_unicode_symbols = false
2019-01-16 23:34:39 +08:00
# Enable Vim compatible mode, avoid changing origin Vim key bindings
2018-06-03 20:38:01 +08:00
vimcompatible = true
2018-04-23 21:21:29 +08:00
# Enable autocomplete layer
[[layers]]
2019-01-22 14:07:48 +08:00
name = 'autocomplete'
auto-completion-return-key-behavior = "complete"
auto-completion-tab-key-behavior = "cycle"
2018-04-23 21:21:29 +08:00
[[layers]]
2019-01-22 14:07:48 +08:00
name = 'shell'
default_position = 'top'
default_height = 30
2018-04-23 21:21:29 +08:00
```
2018-03-25 18:53:01 +08:00
**Iedit mode**
2019-01-16 23:34:39 +08:00
SpaceVim uses a powerful iedit mode to quick edit multiple occurrences of a symbol or selection. Two new modes:`iedit-Normal`/`iedit-Insert`.
2018-03-25 18:53:01 +08:00
The default color for iedit is `red` /`green` which is based on the current colorscheme.
2018-09-01 11:18:47 +08:00
2018-03-25 18:53:01 +08:00
2018-02-15 21:02:45 +08:00
**Highlight cursor symbol**
SpaceVim supports highlighting of the current symbol on demand and adds
a transient state to easily navigate and rename this symbol.
2018-02-01 20:56:53 +08:00
[**Fly Grep in Vim** ](https://spacevim.org/grep-on-the-fly-in-spacevim/ )
2019-01-16 23:34:39 +08:00
With this feature, Vim will display the searching result as you type. Of course, it is running
2018-02-01 20:56:53 +08:00
asynchronously. Before using this feature, you need to install a searching tool. FlyGrep works
through search tools: `ag` , `rg` , `ack` , `pt` and `grep` , Choose one you like.
2018-08-16 21:21:53 +08:00
[**Mnemonic key bindings navigation** ](https://spacevim.org/mnemonic-key-bindings-navigation/ )
2018-01-27 01:07:02 +08:00
2018-01-30 20:33:04 +08:00
You don't need to remember any key bindings, as the mapping guide will show up after the < kbd > SPC< / kbd > is pressed.
2018-03-15 21:47:42 +08:00
The mapping guide is also available for `g` , `z` , and `s` .
2017-10-01 20:32:36 +08:00
2020-08-01 10:51:28 +08:00
2018-01-30 20:33:04 +08:00
2018-08-16 21:21:53 +08:00
[**Help description for key bindings** ](https://spacevim.org/help-description-for-key-bindings/ )
2018-01-30 20:33:04 +08:00
2019-01-16 23:34:39 +08:00
Use < kbd > SPC h d k</ kbd > to get the help description of a key binding, and `gd` to find definition of key bindings.
2018-01-30 20:33:04 +08:00
2018-08-16 21:21:53 +08:00
[**Asynchronous plugin manager** ](https://spacevim.org/Asynchronous-plugin-manager/ )
2018-01-30 20:33:04 +08:00
2019-01-16 23:34:39 +08:00
Create an UI for [dein.vim ](https://github.com/Shougo/dein.vim/ ) - the best asynchronous vim plugin manager
2017-03-29 00:27:08 +08:00
2018-01-30 20:33:04 +08:00
2017-07-21 05:35:34 +08:00
2018-01-30 20:33:04 +08:00
For more features, please read [SpaceVim's Blog ](https://spacevim.org/blog/ )
2018-02-20 22:02:00 +08:00
### Project layout
2017-10-10 19:34:54 +08:00
2017-12-21 20:23:03 +08:00
```txt
2018-02-22 21:15:46 +08:00
├─ .ci/ build automation
├─ .github/ issue/PR templates
├─ .SpaceVim.d/ project specific configuration
├─ autoload/SpaceVim.vim SpaceVim core file
├─ autoload/SpaceVim/api/ Public APIs
├─ autoload/SpaceVim/layers/ available layers
├─ autoload/SpaceVim/plugins/ buildin plugins
2017-12-21 20:23:03 +08:00
├─ autoload/SpaceVim/mapping/ mapping guide
2018-02-22 21:15:46 +08:00
├─ doc/ help(cn/en)
2018-01-30 20:33:04 +08:00
├─ docs/ website(cn/en)
├─ wiki/ wiki(cn/en)
2018-04-01 01:51:54 +08:00
├─ bin/ executable
2020-06-13 14:06:35 +08:00
├─ bundle/ forked repos
2017-12-21 20:23:03 +08:00
└─ test/ tests
```
2017-10-10 19:34:54 +08:00
2018-02-20 22:02:00 +08:00
### Support SpaceVim
2017-02-10 19:43:38 +08:00
2019-01-16 23:34:39 +08:00
The best way to support SpaceVim is to contribute to it either by reporting bugs.
Helping the community on the [Gitter Chat ](https://gitter.im/SpaceVim/SpaceVim ) or sending pull requests.
2018-02-21 20:05:03 +08:00
2019-01-16 23:34:39 +08:00
For more information please check our [development guidelines ](https://spacevim.org/development/ ).
2017-02-25 20:45:31 +08:00
2019-01-16 23:34:39 +08:00
If you want to show your support financially you can buy a drink for the maintainer by clicking following icon.
2017-02-25 20:45:31 +08:00
2018-03-04 20:41:56 +08:00
< a href = 'https://ko-fi.com/spacevim' target = '_blank' > < img height = '36' style = 'border:0px;height:36px;' src = 'https://az743702.vo.msecnd.net/cdn/kofi4.png?v=f' border = '0' alt = 'Buy Me a Coffee at ko-fi.com' / > < / a >
2017-02-25 20:45:31 +08:00
2018-04-23 21:21:29 +08:00
| wechat | alipay |
| ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
2018-03-04 20:13:13 +08:00
| < a href = '#support-spacevim' > < img src = "https://spacevim.org/img/weixin.png" height = "150" width = "150" / > < / a > | < a href = '#support-spacevim' > < img src = "https://spacevim.org/img/zhifubao.png" height = "150" width = "150" / > < / a > |
2017-11-13 17:07:00 +08:00
2017-11-26 20:41:37 +08:00
Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv
2018-02-20 22:02:00 +08:00
### Credits & Thanks
2017-07-21 05:35:34 +08:00
2019-01-16 23:34:39 +08:00
This project exists to thank all the people who have [contributed ](CONTRIBUTING.md ):
2019-01-21 22:41:23 +08:00
2018-03-04 20:41:56 +08:00
< a href = "https://github.com/SpaceVim/SpaceVim/graphs/contributors" > < img src = "https://opencollective.com/spacevim/contributors.svg?width=890&button=false" / > < / a >
2018-04-23 21:21:29 +08:00
2017-10-01 20:53:57 +08:00
- [@Gabirel ](https://github.com/Gabirel ) and his [Hack-SpaceVim ](https://github.com/Gabirel/Hack-SpaceVim )
2018-01-30 20:33:04 +08:00
- [@everettjf ](https://github.com/everettjf ) and his [SpaceVimTutorial ](https://everettjf.gitbooks.io/spacevimtutorial/content/ )
2017-02-10 19:43:38 +08:00
- [vimdoc ](https://github.com/google/vimdoc ) generate doc file for SpaceVim
- [Rafael Bodill ](https://github.com/rafi ) and his vim-config
- [Bailey Ling ](https://github.com/bling ) and his dotvim
2019-01-16 23:34:39 +08:00
- Authors of all the plugins used in SpaceVim.
2017-12-21 20:23:03 +08:00
<!-- vim:set nowrap: -->
