space-vim

An elegant vim distribution inspired by spacemacs

What is space-vim?

space-vim is a vim distribution for vim plugins and resources, compatible with Vim and NeoVim.

It is inspired by spacemacs and mimics spacemacs in a high level, especially in the whole architecture, key bindings and GUI.

If you are unfamiliar with spacemacs, you can visit spacemacs.org for more about the priciple behind that, which is also what space-vim seeks.

For whom?

  • the novice vim users
  • the vimmers who pursuit a beautiful appearance
  • the users using both vim and spacemacs

If you have been a vimmer for a while, just pick out the part you like.

Beautiful interface

space-vim-dark ports spacemacs-dark-theme from spacemacs to vim.

Mnemonic keybindings

Key bindings are organized using mnemonic prefixes like b for buffer, w for window etc…

Meanwhile, the whole key bindings have been well adapted for vim for the lack of great plugins similar to which-key in emacs. Most key bindings are limited to no more than two keystrokes without counting or in, e.g. SPC x d to delete trailing whitespaces.

Easy to customise

The distribution is completely customizable using .spacevim, which is equivalent to .spacemacs in spacemacs.

Get Started

Prerequisites

  • Vim with python or +python3 feature
  • git

Install

Linux and macOS

  • curl

                              
    sh -c "$(curl -fsSL https://raw.githubusercontent.com/liuchengxu/space-vim/master/install.sh)"
  • wget

                              
    sh -c "$(wget -qO- https://raw.githubusercontent.com/liuchengxu/space-vim/master/install.sh)"
  • For neovim, after the quick installer is done, you still need to create a symlink:

                              
    ln -s ~/.space-vim/init.vim ~/.config/nvim/init.vim

Windows

There is no auto-installer for windows users currently, please install space-vim manually accroding to the following instructions:

  1. Install git.
  2. Download Vim and Python.
  3. Install vim-plug:

    Windows (Powershell)

                          
    md ~\.vim\autoload
    $uri = 'https://raw.githubusercontent.com/junegunn/vim-plug/master/plug.vim'
    (New-Object Net.WebClient).DownloadFile($uri, $ExecutionContext.SessionState.Path.GetUnresolvedProviderPathFromPSPath("~\.vim\autoload\plug.vim"))
  4. Enter your home directory, Open Git Bash by right-clicking and choosing the option Git Bash Here. Run the following commands to download space-vim and make a symlink.

                        
    git clone https://github.com/liuchengxu/space-vim.git ~/.space-vim
    ln -s ~/.space-vim/init.vim ~/.vimrc
  5. Create .spacevim in home directory.


    function! Layers()
    Layer 'fzf'
    Layer 'unite'
    Layer 'better-defaults'
    endfunction

    function! UserInit()
    endfunction

    function! UserConfig()
    endfunction
  6. Open vim, run :PlugInstall.

Full Documentation

Please visit GitHub for more information about space-vim!

More on GitHub

License

space-vim is made by Liu-Cheng Xu and is under the MIT License.

Contact

If you encounter any problem or have any suggestions, please create an issue on GitHub.