Vim script Python Shell Batchfile Makefile
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

badge license Build Status


space-vim

前言 | 运行截图 | 适用人群 | 开始使用 | 个性化 | 更新 | 默认安装 | 基础键位 | 使用建议

Table of Contents

Introduction

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 have ever tried spacemacs, you will find space-vim is very similar to it in user experience.

Elegance here means pleasing, graceful as well as simple. 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.

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

screenshot (Terminal vim with space-vim-dark theme)

Features

  • Beautiful interface: I have written a vim colorscheme space-vim-dark based on spacemacs-dark theme. You could also try spacemacs-theme.vim. More screenshots

    screenshot (Terminal vim with set termguicolors)

  • Mnemonic key bindings: commands have mnemonic prefixes like SPC b for all the buffer commands. Lots of basic key bindings are provided by vim-better-default.

    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 <Leader> or <LocalLeader> in, e.g. SPC x d to delete trailing whitespaces.

    For different language layers, <LocalLeader>, , as default in space-vim, can be seen as the major-mode prefix in spacemacs.

  • Lean and mean: no nonsense wrappers, free from being bloated.

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 quite a while, just pick out the part you are interested in. space-vim is well-organized due to the layers concept, you can easily find what you want. Since some guys are interested in the statusline part of space-vim, this section has been extracted as eleline.vim.

Install

Prerequisites

Make sure you have installed:

  • git
  • Vim or NeoVim

The most recent Vim(NeoVim) version is recommended, for space-vim has been specifically optimized for Vim8 and NeoVim with respect to the startup time.

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

Linux and macOS

one-line installer

$ bash <(curl -fsSL https://raw.githubusercontent.com/liuchengxu/space-vim/master/install.sh)

Makefile

$ git clone https://github.com/liuchengxu/space-vim.git ~/.space-vim
$ cd ~/.space-vim
$ make vim     # install space-vim for Vim
$ make neovim  # install space-vim for NeoVim

Windows

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

windows

Manual

Given git and Vim/NeoVim have been installed already:

  1. Clone space-vim

    $ git clone https://github.com/liuchengxu/space-vim.git ~/.space-vim
  2. Install vim-plug, refer to vim-plug installation section for more information.

  3. Create the symlinks.

    Linux and macOS

    # For Vim
    $ ln -s ~/.space-vim/init.vim ~/.vimrc
    
    # For NeoVim
    $ ln -s ~/.space-vim/init.vim ~/.config/nvim/init.vim
    
    # Both for Vim and NeoVim
    $ cp ~/.space-vim/init.spacevim ~/.spacevim
  4. Open vim, then space-vim will automatically install the missing plugins. If auto-installation fails unexpectly, please try running :PlugInstall manually.

Customize

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

If .spacevim does not exist, vanilla vim will be loaded! Refer to init.spacevim as an example.

Presetting

" Let Vim and NeoVim shares the same plugin directory
let g:spacevim_plug_home = '~/.vim/plugged'

" The default leader key is space key.
" Uncomment the line below and modify "<\Space>" if you prefer another
" let g:spacevim_leader = "<\Space>"

" The default local leader key is comma.
" Uncomment the line below and modify ',' if you prefer another
" let g:spacevim_localleader = ','

" Enable the existing layers in space-vim
let g:spacevim_layers = [
      \ 'fzf', 'unite', 'better-defaults',
      \ 'which-key',
      \ ]

" If you want to have more control over the layer, try using Layer command.
" if g:spacevim_gui
"   Layer 'airline'
" endif

Please refer to LAYERS.md to take a look at the whole shipped layers.

Basically, g:spacevim_layers almost takes the place of Layer command. As far as I known, most people never use the option of Layer command, e.g., exclude, so g:spacevim_layers could save a lengthy Layer list, requiring less ceremony. Nevertheless, Layer command is still avaiable for some advanced uses.

UserInit()

" Manage your own plugins, refer to vim-plug's instruction for more detials.
function! UserInit()

  " Add plugin via Plug command.
  Plug 'junegunn/seoul256.vim'

endfunction

UserConfig()

" Override the default settings as well as adding extras
function! UserConfig()

  " If you have installed the powerline fonts and want to enable airline layer
  " let g:airline_powerline_fonts=1

  " Use gui colors in terminal if available
  if has('termguicolors')
    set termguicolors
    if g:spacevim_tmux
      " If use vim inside tmux, see https://github.com/vim/vim/issues/993
      " set Vim-specific sequences for RGB colors
      let &t_8f = "\<Esc>[38;2;%lu;%lu;%lum"
      let &t_8b = "\<Esc>[48;2;%lu;%lu;%lum"
    endif
  endif

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. The private directory can be considered as either a single layer, i.e., in which you can put packages.vim and config.vim, or a set of multiple layers.

How to use

First of all, I recommend you to look through the existing key bindings via SPC ?. What's more, you definitely can not miss reading the README of better-defaults layer, which is of great importance for you to get started quickly.

For detailed instruction, please refer to the README under the certain 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 stuff are waiting to be done.

Bootstrap

The modular design is originally from spacemacs. The implementation of logic in space-vim is similar to vim-plug.

If you want to know more about the bootstrap of space-vim, please see bootstrap in wiki.

Commands

Command Description
LayerStatus Check the status of layers
LayerCache Cache the information of layers in info.vim

Tips

For the sake of a better user experience, some extra settings should be done.

Enable GUI color in terminal vim

echo has('termguicolors'), if 1, then you can enable GUI color in terminal vim, add this to UserConfig():

set termguicolors

" If you use vim inside tmux, see https://github.com/vim/vim/issues/993
" set Vim-specific sequences for RGB colors
let &t_8f = "\<Esc>[38;2;%lu;%lu;%lum"
let &t_8b = "\<Esc>[48;2;%lu;%lu;%lum"

For more details about true colour, please see the gist TrueColour.md.

Terminal Font

iterm2-font-setting

First, install the Source Code Pro or Powerline font, which is important for airline layer.

Second, since console Vim uses whatever font the console/terminal is using, you'll have to change the font setting of your terminal.

Update

Run make update:

$ cd path/to/space-vim
$ make update

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 origin master

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

I would like to thank the many people who have helped and contributed to this project. What's more, space-vim would never have become what it is now, without the help of these projects!

Articles

Contributors

This project exists thanks to all the people who contribute.