SpaceVim README

The project's README from github.com/wsdjeg/SpaceVim. As one markdown file: README.md.

SpaceVim

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

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

SpaceVim (wsdjeg/SpaceVim)

Searching Database…

20.2K ·GitHub
archived
What is this?SpaceVim is a modular configuration for Vim and Neovim, inspired by spacemacs, that turns a plain editor into a batteries-included development environment.
Is SpaceVim its own editor, or something I put on top of the Vim I already have?It's not a separate app or fork. It's a configuration that sits on top of Vim or Neovim and organizes plugins into layers, each layer bundling related packages into one feature.
How do I get it installed?The README doesn't inline the commands — it points to a Quick Start Guide and the online documentation, which walk you through the setup.
Do I need Vim or Neovim already installed on my machine?Yes — SpaceVim is a configuration for Vim or Neovim, not a standalone program, so one of the two must be installed first; SpaceVim then handles the plugins for you.
Is SpaceVim still being developed?Heads-up: the GitHub repository is archived, so the code there is read-only and no longer receives updates — worth knowing before investing in deep customization.
Is it terminal-only, or does it work in GUI Vim too?It runs wherever Vim or Neovim do — Windows, macOS, Linux — and is built to feel the same in terminal and GUI Vim.
Do I have to pick and configure every plugin myself?No — that's the point of layers: related packages come collected together per feature, so you don't have to think about what to install.
What do I get out of the box?Layered plugin organization, compatible APIs for Vim and Neovim, beautiful UI, online documentation plus :h SpaceVim help, and core plugins rewritten in Lua.
What's the idea behind the space key bindings?Ergonomics: SpaceVim leans on the space bar instead of modifier combos to lower the risk of RSI, and a guide of available bindings pops up automatically.
Will it make my editor slow to start?It's built for fast boot: 90% of plugins are lazy-loaded with dein.vim, so they only load when actually needed.
Creator
wsdjeg
Size
69 MB
Stars
20.2K
Updated
CommitFeb 17
Age
9y
Commits · 90 Days