mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-03-13 10:15:41 +08:00
103 lines
5.2 KiB
Markdown
103 lines
5.2 KiB
Markdown
[](https://spacevim.org)
|
|
|
|
[Wiki](https://github.com/SpaceVim/SpaceVim/wiki) |
|
|
[Documentation](http://spacevim.org/documentation/) |
|
|
[Twitter](https://twitter.com/SpaceVim) |
|
|
[Community](https://spacevim.org/community/) |
|
|
[Gitter **Chat**](https://gitter.im/SpaceVim/SpaceVim)
|
|
|
|
[](https://travis-ci.org/SpaceVim/SpaceVim)
|
|
|
|
[](LICENSE)
|
|
[](doc/SpaceVim.txt)
|
|
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Average time to resolve an issue")
|
|
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
|
|
|
|
[SpaceVim](https://github.com/SpaceVim/SpaceVim) is a community-driven vim distribution with a bundle of modular configuration,
|
|
here we call these modules as layers, each layer has different plugins and config, users just need
|
|
to select the layers they need. It got inspired by [spacemacs](https://github.com/syl20bnr/spacemacs). If you use SpaceVim,
|
|
please star it on github. It's a great way of getting feedback and gives me the kick to
|
|
put more time into development.
|
|
|
|
|
|
|
|
- **Great documentation:** access documentation in Vim with
|
|
<kbd>:h SpaceVim</kbd>.
|
|
- **Beautiful GUI:** you'll love the awesome UI and its useful features.
|
|
- **Mnemonic key bindings:** commands have mnemonic prefixes like
|
|
<kbd>[Window]</kbd> for all the window and buffer commands or <kbd>[Unite]</kbd> for the
|
|
unite work flow commands.
|
|
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim]
|
|
- **Batteries included:** discover hundreds of ready-to-use packages nicely
|
|
organised in configuration layers following a set of
|
|
[conventions](http://spacevim.org/development/).
|
|
- **Neovim centric:** Dark powered mode of SpaceVim
|
|
|
|
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:
|
|
|
|
[](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
|
|
|
|
|
|
## Install
|
|
|
|
```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
|
|
```
|
|
|
|
|
|
|
|
## Community
|
|
|
|
Try these SpaceVim hangouts for any questions, problems or comments.
|
|
- Chat
|
|
- [](https://gitter.im/SpaceVim/SpaceVim?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
|
- [](https://jq.qq.com/?_wv=1027&k=43DB6SG)
|
|
- [](https://www.facebook.com/SpaceVim)
|
|
- Ask
|
|
- [issue tracker](https://github.com/SpaceVim/SpaceVim/issues) for issue and feature requests
|
|
- vi StackExchange for "how to" & configuration questions
|
|
- [](https://twitter.com/SpaceVim) for hugs & pithy comments
|
|
- Discuss
|
|
- [google mailing list](https://groups.google.com/forum/#!forum/spacevim)
|
|
|
|
|
|
## Support SpaceVim
|
|
|
|
The best way to support SpaceVim is to contribute to it either by reporting bugs, helping the community on the Gitter Chat or sending pull requests.
|
|
|
|
If you want to show your support financially you can contribute to [Bountysource](https://www.bountysource.com/teams/spacevim) or buy a drink for the maintainer by clicking following icon.
|
|
|
|
<a href='https://ko-fi.com/A538L6H' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi4.png?v=f' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
|
|
|
|
If you used SpaceVim in a project and you want to show that fact, you can use the SpaceVim badge:
|
|
|
|
[](https://spacevim.org)
|
|
|
|
markdown
|
|
|
|
```markdown
|
|
[](https://spacevim.org)
|
|
```
|
|
|
|
### contribute to SpaceVim
|
|
|
|
Before contributing be sure to consult the [contribution guidelines](http://spacevim.org/development/#contribution-guidelines) and [conventions](http://spacevim.org/development/#conventions).
|
|
|
|
## Credits & Thanks
|
|
|
|
- [](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
|
|
- [vimdoc](https://github.com/google/vimdoc) generate doc file for SpaceVim
|
|
- [Rafael Bodill](https://github.com/rafi) and his vim-config
|
|
- [Bailey Ling](https://github.com/bling) and his dotvim
|
|
- authors of all the plugins used in SpaceVim.
|