Skip to content

wsdjeg/SpaceVim

Repository files navigation

Quick Start Guide | Chat | Documentation | Layers

build Codecov coverage Release GPLv3 License

work-flow

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

Features

  • Modularization: plugins and functions are organized in layers.
  • Compatible api: a series of compatible APIs for Vim/Neovim.
  • Great documentation: online documentation and :h SpaceVim.
  • Better experience: rewrite core plugins using lua
  • Beautiful UI: you'll love the awesome UI and its useful features.
  • Mnemonic key bindings: key binding guide will be displayed automatically
  • Fast boot time: Lazy-load 90% of plugins with dein.vim
  • Lower the risk of RSI: by heavily using the space bar instead of modifiers.
  • Consistent experience: consistent experience between terminal and gui

Project Layout

├─ .ci/                           build automation
├─ .github/                       issue/PR templates
├─ .SpaceVim.d/                   project specific configuration
├─ after/                         overrule or add to the distributed defaults
├─ autoload/SpaceVim.vim          SpaceVim core file
├─ autoload/SpaceVim/api/         Public APIs
├─ autoload/SpaceVim/layers/      available layers
├─ autoload/SpaceVim/plugins/     builtin plugins
├─ autoload/SpaceVim/mapping/     mapping guide
├─ colors/                        default colorscheme
├─ docker/                        docker image generator
├─ bundle/                        bundle plugins
├─ lua/spacevim/plugin            builtin plugins(lua)
├─ doc/                           help(cn/en)
├─ docs/                          website(cn/en)
├─ wiki/                          wiki(cn/en)
├─ bin/                           executable
└─ test/                          tests

Contribute

This project wouldn't exist without all the people who contributed, We are thankful for any contributions from the community.

Credits