---

🇨🇳 中文简介

***

***

Table of Contents

• Introduction
• Features
• Install
  • Linux and macOS
  • Windows
• Customize
• Command
  • Layer
  • Exclude
• Update
• FAQ
• Contributions
• Acknowledgements

Introduction

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

It is inspired by spacemacs, espcially in key bindings and GUI. if have ever tried spaceamcs, you will find spacevim is very similar to it in user experience.

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

Features

• Beautiful GUI: I have also written a vim colorscheme space-vim-dark based on spacemacs-dark theme.
• Mnemonic key bindings: commands have mnemonic prefixes like SPC b for all the buffer commands.

Install

You have to satisfy some prerequisites at first: vim with +python or +python3 feature, git.

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)"

Windows

Not tested now.

⚠️ For neovim, after the installer is done, you still need to create a symlink:

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

❗ When layers enabled at the first time, you need to run :PlugInstall to install relevant plugins.

Customize

You can use .spacevim in your home directory to customize space-vim, where you can enable existing layers, add your extra plugins and private configuration.

" Put layers you want to enable as well as extra private plugins
function! UserInit()
    " Space has been set as the default leader key,
    " if you want to change it, uncomment and set it here.
    " let g:spacevim_leader = "<\Space>"
    " let g:spacevim_localleader = ','

    " Put the layers you want to enable
    " Layer 'emoji'

    " Put private plugins
    " Plug 'junegunn/vim-github-dashboard'
endfunction

" Customize configuration
function! UserConfig()
    " color space-vim-dark
endfunction

If have a heavy customized configuration, you can organize them in private directory with packages.vim and config.vim too, which will be loaded on startup.

Command

Layer

Use Layer command in .spacevim to enable a existing layer, e.g., Layer 'python'.

Exclude

Use Exclude command in .spacevim to remove a plugin in the layers enabled, e.g., Exclude 'Shougo/denite.nvim'. If use Exclude command, you need to run :PlugClean to gurantee the relevant configurations not to be loaded.

For more information, please refer to the README under the layer enabled, or you can see config.vim and packages.vim directly.

If the README is not elaborate, sorry for that, space-vim now is in the early stages and a ton of stuffs are waitting to be done.

Update

The simpliest way to update is to reinstall it completely by rerunning the installer above. It will non destructively upgrade to the latest version.

Alternatively you can manually perform the following steps. If anything has changed with the structure of the configuration, you will have to create the appropriate symlinks.

cd path/to/space-vim/
git pull
vim +PlugInstall! +PlugUpdate +PlugClean +q

FAQ

Q: Why develop this?

A: I was amazed by spacemacs' beautiful GUI and mnemonic key bindings when use it at the first time. Now I often use spacemacs when in GUI environment. But in terminal, vim is definitely my first choice. Then I hope to maintain consistency in operation in the two scenes as much as possible. Hence I try to reconfig the vim based on spacemacs's architecture, especially in key bindings and GUI. This is space-vim at present.

Contributions

If you encounter any problem or have any suggestions, please open an issue or send a PR.

Space-vim is still in beta. If you are interested, contributions are highly welcome.

Acknowledgements

• spacemacs
• vim-plug
• spf13-vim
• ......