Wiki | Documentation | Twitter | Community | Gitter Chat | 中文官网

SpaceVim is a distribution of the vim editor that's inspired by spacemacs. It manages collections of plugins in layers, which help collect related packages together to provide features. This approach helps keep configuration organized and reduces overhead for the user by keeping them from having to think about what packages to install.

See the quick start guide, documentation or the available layers for more information.

Here is a throughput graph of the repository for the last few weeks:

• Features
• Install
  • Linux and macOS
  • Windows
• Project layout
• Support SpaceVim
• Credits & Thanks

Features

Highlight cursor symbol

SpaceVim supports highlighting of the current symbol on demand and adds a transient state to easily navigate and rename this symbol.

Fly Grep in Vim

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.

Mnemonic key bindings navigation

You don't need to remember any key bindings, as the mapping guide will show up after the SPC is pressed. The mapping guide is also available for g, z, s, f and F.

Help description for key bindings

use SPC h d k to get the help description of a key binding, and gd to find definition of key bindings.

Asynchronous plugin manager

create an UI for dein.vim - the best asynchronous vim plugin manager

For more features, please read SpaceVim's Blog

Install

At a minimum, SpaceVim requires git to be installed. For a better graphical experience, install nerd-font and make sure your terminal supports true colors.

Linux and macOS

curl -sLf https://spacevim.org/install.sh | bash

After SpaceVim is installed, launch vim and SpaceVim will automatically install plugins.

For more info about the install script, please check:

curl -sLf https://spacevim.org/install.sh | bash -s -- -h

Windows

The easist way is to download install.cmd and run it as administrator, or install SpaceVim manually.

Project layout

├─ autoload/SpaceVim/api/         APIs
├─ autoload/SpaceVim/layers/      layers
├─ autoload/SpaceVim/plugins/     plugins
├─ autoload/SpaceVim/mapping/     mapping guide
├─ doc/SpaceVim.txt               help
├─ docs/                          website(cn/en)
├─ wiki/                          wiki(cn/en)
├─ bin/                           executeable
└─ test/                          tests

Support SpaceVim

The best way to support SpaceVim is to contribute to it either by reporting bugs, helping the community on the Gitter Chat or sending pull requests.

If you want to show your support financially you can buy a drink for the maintainer by clicking following icon.

wechat	alipay

Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv

Credits & Thanks

• 
• @Gabirel and his Hack-SpaceVim
• @everettjf and his SpaceVimTutorial
• vimdoc generate doc file for SpaceVim
• Rafael Bodill and his vim-config
• Bailey Ling and his dotvim
• authors of all the plugins used in SpaceVim.