mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-24 06:10:05 +08:00
102 lines
5.0 KiB
Markdown
102 lines
5.0 KiB
Markdown
---
|
|
title: "Home"
|
|
description: "SpaceVim is a community-driven vim distribution that seeks to provide layer feature."
|
|
---
|
|
|
|
[![Gitter](https://badges.gitter.im/SpaceVim/SpaceVim.svg)](https://gitter.im/SpaceVim/SpaceVim)
|
|
[![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev)](https://travis-ci.org/SpaceVim/SpaceVim)
|
|
[![Build status](https://ci.appveyor.com/api/projects/status/eh3t5oph70abp665/branch/dev?svg=true)](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/dev)
|
|
[![codecov](https://codecov.io/gh/SpaceVim/SpaceVim/branch/dev/graph/badge.svg)](https://codecov.io/gh/SpaceVim/SpaceVim/branch/dev)
|
|
[![Version](https://img.shields.io/badge/version-0.7.0--dev-FF00CC.svg)](https://github.com/SpaceVim/SpaceVim)
|
|
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/dev/LICENSE)
|
|
|
|
SpaceVim is a distribution of the vim editor that's inspired by spacemacs. It manages collections of plugins in layers, which help collect related packages together to provide features. For example, the python layer collects deoplete.nvim, neomake and jedi-vim together to provides autocompletion, syntax checking, and documentation lookup. This approach helps keep configuration organized and reduces overhead for the user by keeping them from having to think about what packages to install.
|
|
|
|
Please star the project on github - it is a great way to show your appreciation while providing us motivation to continue working on this project. The extra visibility for the project doesn't hurt either!
|
|
|
|
![welcome-page](https://user-images.githubusercontent.com/13142418/33793078-3446cb6e-dc76-11e7-9998-376a355557a4.png)
|
|
|
|
See the [documentation](https://spacevim.org/documentation) or [the list of layers](http://spacevim.org/layers/) for more information.
|
|
|
|
Here is a throughput graph of the repository for the last few weeks:
|
|
|
|
[![Throughput Graph](https://graphs.waffle.io/SpaceVim/SpaceVim/throughput.svg)](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
|
|
|
|
## Requirements
|
|
|
|
At a minimum, SpaceVim requires `git` and `wget` to be installed. These tools are needed for downloading plugins and fonts.
|
|
|
|
If you are new to vim, you should learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore).
|
|
|
|
## Install
|
|
|
|
### Linux and macOS
|
|
|
|
```bash
|
|
curl -sLf https://spacevim.org/install.sh | bash
|
|
```
|
|
|
|
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
|
|
|
|
For more info about the install script, please check:
|
|
|
|
```bash
|
|
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
|
|
```
|
|
|
|
### Windows
|
|
|
|
The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually.
|
|
|
|
## Features
|
|
|
|
- **Great documentation:** access documentation in Vim with <kbd>SPC h SPC</kbd>.
|
|
![SPC h SPC](https://user-images.githubusercontent.com/13142418/31620230-48b53eea-b2c9-11e7-90d0-b717878875d4.gif)
|
|
- **Beautiful UI:** you'll love the awesome UI and its useful features.
|
|
![beautiful UI](https://user-images.githubusercontent.com/13142418/33804722-bc241f50-dd70-11e7-8dd8-b45827c0019c.png)
|
|
- **Mnemonic key bindings:** all key bindings have mnemonic prefixes.
|
|
![mapping guide](https://user-images.githubusercontent.com/13142418/31550099-c8173ff8-b062-11e7-967e-6378a9c3b467.gif)
|
|
- **Describe key bindings:** use <kbd>SPC h d k</kbd> to describe key bindings, and find definition of key bindings.
|
|
![describe key](https://user-images.githubusercontent.com/13142418/33804739-52dbc498-dd71-11e7-97e5-ed0fa6ec1719.gif)
|
|
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim)
|
|
![UI for dein](https://user-images.githubusercontent.com/13142418/31309093-36c01150-abb3-11e7-836c-3ad406bdd71a.gif)
|
|
- **Neovim centric:** Dark powered mode of SpaceVim
|
|
|
|
## Blogs
|
|
|
|
<ul>
|
|
{% for post in site.posts offset: 0 limit: 5 %}
|
|
<strong><a href="{{ post.url }}">{{ post.title }}</a></strong>
|
|
<br>
|
|
<span class="post-date">{{ post.date | date_to_string }}</span>
|
|
<p>{{ post.excerpt | truncatewords: 100 }}</p>
|
|
{% endfor %}
|
|
</ul>
|
|
|
|
More posts are in the [SpaceVim's Blog](https://spacevim.org/blog/)
|
|
|
|
[Follow @SpaceVim](https://twitter.com/SpaceVim)
|
|
|
|
## Get Involved
|
|
|
|
Discuss the project at [gitter.im/SpaceVim](https://gitter.im/SpaceVim/SpaceVim) or [/r/SpaceVim](https://www.reddit.com/r/SpaceVim/)
|
|
|
|
Contribute code, report bugs and request features at [GitHub](https://github.com/SpaceVim/SpaceVim).
|
|
|
|
## FAQ
|
|
|
|
1. What is the project status?
|
|
|
|
The current stable version is 0.5.0. See the [milestones page](https://github.com/SpaceVim/SpaceVim/milestones) for development progress and the [roadmap](https://spacevim.org/roadmap/) for high-level plans.
|
|
|
|
2. Is SpaceVim trying to turn Vim/Neovim into an IDE?
|
|
|
|
With layers feature, this version of vim distribution try to turn vim/neovim into an IDE for many languages.
|
|
|
|
3. Which version of vim/neovim is needed?
|
|
|
|
vim 7.4/neovim v0.1.7, and `+lua` or `+python3` is needed.
|
|
|
|
|
|
<!-- vim:set nowrap: -->
|