murongruomeng / spacevim

A community-driven modular vim distribution - The ultimate Vim configuration

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

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 just a vimrc but an ultimate Vim configuration, It contains many build-in features.

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:

• New Features
• Install
• Project layout
• Support SpaceVim
• Credits & Thanks

New Features

This is a list of latest features implemented in SpaceVim:

Iedit mode

SpaceVim uses powerful iedit mode to quick edit multiple occurrences of a symbol or selection. Two new modes:iedit-Normal/iedit-Insert

The default color for iedit is red/green which is based on the current colorscheme.

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, and s.

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 installation script, please check:

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

Windows

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

Project layout

├─ .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
├─ autoload/SpaceVim/mapping/     mapping guide
├─ doc/                           help(cn/en)
├─ docs/                          website(cn/en)
├─ wiki/                          wiki(cn/en)
├─ bin/                           executable
└─ 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.

For more info please check our development guidelines.

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

This project exists thanks to all the people who have contributed:

• @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.