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 ) \|
[Documentation ](http://spacevim.org/documentation/ ) \|
[Twitter ](https://twitter.com/SpaceVim ) \|
[Community ](https://spacevim.org/community/ ) \|
2018-03-04 20:41:56 +08:00
[Sponsors ](http://spacevim.org/sponsors/ ) \|
2017-10-07 22:57:35 +08:00
[Gitter **Chat** ](https://gitter.im/SpaceVim/SpaceVim ) \|
2018-01-27 01:07:02 +08:00
[中文官网 ](http://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)
[](https://codecov.io/gh/SpaceVim/SpaceVim/branch/master)
2018-03-19 21:36:59 +08:00
2018-02-15 22:25:03 +08:00
[](LICENSE)
2017-05-01 20:36:41 +08:00
[](doc/SpaceVim.txt)
2017-05-01 14:09:17 +08:00
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Average time to resolve an issue")
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
2017-02-05 10:03:28 +08:00
2018-02-20 22:02:00 +08:00
SpaceVim is a community-driven modular vim distribution. It manages collections
of plugins in layers, which help collect related packages together to provide IDE-like features.
SpaceVim is not only a vimrc but an ultimate Vim configuration, It contains many build-in features.
2017-01-04 21:04:42 +08:00
2018-03-19 21:36:59 +08:00
2017-02-25 16:57:35 +08:00
2018-01-30 20:33:04 +08:00
See the [quick start guide ](https://spacevim.org/quick-start-guide ), [documentation ](https://spacevim.org/documentation ) or the [available layers ](http://spacevim.org/layers/ ) for more information.
2017-05-30 15:27:03 +08:00
2017-08-24 04:01:43 +08:00
Here is a throughput graph of the repository for the last few weeks:
2017-05-30 15:27:03 +08:00
2017-08-24 04:01:43 +08:00
[](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
2017-05-30 15:27:03 +08:00
2018-01-30 20:33:04 +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
- [Install ](#install )
- [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-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/ )
With this feature, vim will display the searching result as you type. Of course, it is running
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-01-30 20:33:04 +08:00
[**Mnemonic key bindings navigation** ](http://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
2018-01-30 20:33:04 +08:00
[**Help description for key bindings** ](http://spacevim.org/help-description-for-key-bindings/ )
use < kbd > SPC h d k</ kbd > to get the help description of a key binding, and `gd` to find definition of key bindings.
[**Asynchronous plugin manager** ](http://spacevim.org/Asynchronous-plugin-manager/ )
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
### Install
2018-01-30 20:33:04 +08:00
At a minimum, SpaceVim requires `git` to be installed. For a better graphical experience, install [nerd-font ](https://github.com/ryanoasis/nerd-fonts ) and make sure your terminal supports [true colors ](https://gist.github.com/XVilka/8346728 ).
2018-02-20 22:02:00 +08:00
**Linux and macOS**
2017-11-05 20:34:40 +08:00
2017-07-21 05:35:34 +08:00
```bash
curl -sLf https://spacevim.org/install.sh | bash
```
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
2017-09-29 10:21:29 +08:00
For more info about the install script, please check:
2017-07-21 05:35:34 +08:00
```bash
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
```
2018-02-20 22:02:00 +08:00
**Windows**
2017-11-05 20:34:40 +08:00
The easist way is to download [install.cmd ](https://spacevim.org/install.cmd ) and run it as administrator, or install SpaceVim manually.
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)
2017-12-21 20:23:03 +08:00
├─ bin/ executeable
└─ test/ tests
```
2017-10-10 19:34:54 +08:00
2017-02-25 19:47:13 +08:00
2018-02-20 22:02:00 +08:00
### Support SpaceVim
2017-02-10 19:43:38 +08:00
2018-01-30 20:33:04 +08:00
The best way to support SpaceVim is to contribute to it either by reporting bugs,
2018-02-21 20:05:03 +08:00
helping the community on the [Gitter Chat ](https://gitter.im/SpaceVim/SpaceVim ) or sending pull requests.
For more info please check our [development guidelines ](http://spacevim.org/development/ ).
2017-02-25 20:45:31 +08:00
2018-01-30 20:33:04 +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
2017-11-13 17:07:00 +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
2018-03-04 20:41:56 +08:00
This project exists thanks to all the people who have [contributed ](CONTRIBUTING.md ):
< a href = "https://github.com/SpaceVim/SpaceVim/graphs/contributors" > < img src = "https://opencollective.com/spacevim/contributors.svg?width=890&button=false" / > < / a >
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
2017-07-21 05:35:34 +08:00
- authors of all the plugins used in SpaceVim.
2017-12-21 20:23:03 +08:00
<!-- vim:set nowrap: -->
