1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 09:30:04 +08:00
SpaceVim/docs/index.md

94 lines
4.5 KiB
Markdown
Raw Normal View History

2017-02-15 22:05:31 +08:00
---
title: "Home"
2017-09-22 22:35:43 +08:00
description: "SpaceVim is a community-driven vim distribution that seeks to provide layer feature."
2017-02-15 22:05:31 +08:00
---
2017-11-18 20:40:42 +08:00
[![Gitter](https://badges.gitter.im/SpaceVim/SpaceVim.svg)](https://gitter.im/SpaceVim/SpaceVim)
2017-02-06 21:38:14 +08:00
[![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev)](https://travis-ci.org/SpaceVim/SpaceVim)
2017-11-18 20:14:13 +08:00
[![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)
2017-11-18 20:40:42 +08:00
[![Version](https://img.shields.io/badge/version-0.6.0--dev-FF00CC.svg)](https://github.com/SpaceVim/SpaceVim/releases/tag/0.5.0)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/dev/LICENSE)
2017-11-18 20:14:13 +08:00
SpaceVim is a community-driven vim distribution that supports vim and Neovim. SpaceVim manages collections of plugins in layers. Layers make it easy for you, the user, to enable a new language or feature by grouping all the related plugins together.
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!
2017-12-09 14:12:37 +08:00
![welcome-page](https://user-images.githubusercontent.com/13142418/33793078-3446cb6e-dc76-11e7-9998-376a355557a4.png)
2017-02-06 21:38:14 +08:00
2017-11-18 20:14:13 +08:00
See the [documentation](https://spacevim.org/documentation) or [the list of layers](http://spacevim.org/layers/) for more information.
2017-02-06 21:38:14 +08:00
2017-11-18 20:14:13 +08:00
Here is a throughput graph of the repository for the last few weeks:
2017-05-08 20:15:52 +08:00
2017-11-18 20:14:13 +08:00
[![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.
2017-02-06 21:38:14 +08:00
2017-02-20 22:05:01 +08:00
If you are new to vim, you should learning about Vim in general, read [vim-galore](https://github.com/mhinz/vim-galore).
2017-02-06 21:38:14 +08:00
2017-02-20 22:05:01 +08:00
## Install
2017-02-06 21:38:14 +08:00
2017-11-18 20:14:13 +08:00
### Linux and macOS
2017-02-06 21:38:14 +08:00
2017-11-18 20:14:13 +08:00
```bash
2017-02-06 21:38:14 +08:00
curl -sLf https://spacevim.org/install.sh | bash
```
2017-09-13 23:27:09 +08:00
2017-11-18 20:14:13 +08:00
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
2017-07-17 09:37:53 +08:00
For more info about the install script, please check:
2017-02-06 21:38:14 +08:00
2017-11-18 20:14:13 +08:00
```bash
2017-02-06 21:38:14 +08:00
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
```
2017-11-18 20:14:13 +08:00
### Windows
2017-02-06 21:38:14 +08:00
2017-11-18 20:14:13 +08:00
The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually.
## Features
2017-11-18 20:14:13 +08:00
- **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)
2017-12-10 20:11:31 +08:00
- **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)
2017-11-18 20:14:13 +08:00
- **Mnemonic key bindings:** all key bindings have mnemonic prefixes.
![mapping guide](https://user-images.githubusercontent.com/13142418/31550099-c8173ff8-b062-11e7-967e-6378a9c3b467.gif)
2017-12-10 20:11:31 +08:00
- **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)
2017-11-18 20:14:13 +08:00
- **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
## News
2017-09-13 23:27:09 +08:00
[Newsletter #1 - A New Hope](https://spacevim.org/SpaceVim-Newsletter-A-New-Hope/)
> Published on: 2017-5-31
More posts are in the [SpaceVim's Blog](https://spacevim.org/blog/)
[Follow @SpaceVim](https://twitter.com/SpaceVim)
## Get Involved
2017-09-13 23:27:09 +08:00
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?
2017-11-18 20:40:42 +08:00
The current stable version is 0.5.0. See the milestones page for development progress and the roadmap for high-level plans.
2. Is SpaceVim trying to turn Vim/Neovim into an IDE?
2017-11-18 20:40:42 +08:00
With layers feature, this version of vim distribution try to turn vim/neovim into an IDE for many language.
2017-11-18 20:40:42 +08:00
3. Which version of vim/neovim is needed?
2017-11-18 20:40:42 +08:00
vim 7.4/neovim v0.1.7, and `+lua` or `+python3` is needed.