2022-06-06 23:27:11 +08:00
< h1 align = "center" >
2022-10-22 22:00:45 +08:00
< a href = "https://github.com/SpaceVim/SpaceVim#readme" >
< img src = "https://spacevim.org/logo.png" width = "440" alt = "SpaceVim" / >
2022-06-06 23:27:11 +08:00
< / a >
< / h1 >
2017-02-25 15:27:15 +08:00
2022-06-06 23:27:11 +08:00
[Quick Start Guide ](https://spacevim.org/quick-start-guide/ ) \|
2022-10-22 09:58:28 +08:00
[Chat ](https://chat.mozilla.org/#/room/#spacevim:matrix.org ) \|
2022-06-06 23:27:11 +08:00
[Twitter ](https://twitter.com/SpaceVim )
2017-01-10 00:27:52 +08:00
2023-02-19 20:15:28 +08:00
[](https://github.com/SpaceVim/SpaceVim/actions/workflows/check.yml?query=branch%3Amaster)
2021-08-10 19:59:42 +08:00
[](https://codecov.io/gh/SpaceVim/SpaceVim)
2023-03-30 20:03:37 +08:00
[](https://spacevim.org/SpaceVim-release-v2.1.0/)
2021-06-06 15:16:47 +08:00
[](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE)
2022-05-23 22:12:46 +08:00
[](https://hub.docker.com/r/spacevim/spacevim)
2017-02-05 10:03:28 +08:00
2023-06-28 12:22:47 +08:00
SpaceVim is a vim configuration inspired by spacemacs, it is compatible with Vim and Neovim.
2017-05-30 15:27:03 +08:00
2022-10-22 22:00:45 +08:00
## Features
2022-10-22 23:43:36 +08:00
- **Modularization:** plugins and functions are organized in [layers ](https://spacevim.org/layers/ ).
- **Compatible api:** a series of [compatible APIs ](https://spacevim.org/api/ ) for Vim/Neovim.
2022-11-12 20:36:21 +08:00
- **Great documentation:** online [documentation ](https://spacevim.org/documentation/ ) and `:h SpaceVim` .
2022-10-22 23:43:36 +08:00
- **Better experience:** rewrite core plugins using lua
2022-10-22 22:00:45 +08:00
- **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 ](https://github.com/Shougo/dein.vim )
- **Lower the risk of RSI:** by heavily using the space bar instead of modifiers.
- **Consistent experience:** consistent experience between terminal and gui
## Screenshots
2023-06-28 12:22:47 +08:00
[](https://github.com/SpaceVim/SpaceVim#screenshots)
2022-10-22 22:00:45 +08:00
## Project Layout
```txt
├─ .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
2022-11-14 15:01:20 +08:00
├─ autoload/SpaceVim/plugins/ builtin plugins
2022-10-22 22:00:45 +08:00
├─ autoload/SpaceVim/mapping/ mapping guide
├─ colors/ default colorscheme
├─ docker/ docker image generator
├─ bundle/ bundle plugins
2022-11-14 15:01:20 +08:00
├─ lua/spacevim/plugin builtin plugins(lua)
2022-10-22 22:00:45 +08:00
├─ doc/ help(cn/en)
├─ docs/ website(cn/en)
├─ wiki/ wiki(cn/en)
├─ bin/ executable
└─ test/ tests
```
2022-10-22 09:58:28 +08:00
## Contribute
2020-09-17 21:53:04 +08:00
2021-08-31 21:31:54 +08:00
This project wouldn't exist without all the people who [contributed ](CONTRIBUTING.md ),
2020-09-29 22:45:40 +08:00
We are thankful for any contributions from the community.
2020-09-17 21:53:04 +08:00
< a href = "https://github.com/SpaceVim/SpaceVim/graphs/contributors" > < img src = "https://opencollective.com/spacevim/contributors.svg?width=890&button=false" / > < / a >
2022-10-22 22:00:45 +08:00
## Credits
2018-04-23 21:21:29 +08:00
2020-10-10 09:51:46 +08:00
- [Hack-SpaceVim ](https://github.com/Gabirel/Hack-SpaceVim ) by [@Gabirel ](https://github.com/Gabirel )
- [SpaceVimTutorial ](https://everettjf.gitbooks.io/spacevimtutorial/content/ ) by [@everettjf ](https://github.com/everettjf )
- [10-minutes-to-SpaceVim ](https://github.com/Jackiexiao/10-minutes-to-SpaceVim ) by [@Jackiexiao ](https://github.com/Jackiexiao )
2021-06-01 22:58:39 +08:00
- [A First Look At SpaceVim ](https://www.youtube.com/watch?v=iXPS_NHLj9k ) by [@DistroTube ](https://www.youtube.com/channel/UCVls1GmFKf6WlTraIb_IaJg )
2022-04-15 10:57:50 +08:00
- [Getting Started With SpaceVim ](https://www.youtube.com/watch?v=3xB501CJDB8 ) by [FOSS King ](https://www.youtube.com/channel/UCfU_sitghekwveLh6yM_xuA )
2023-06-28 12:22:47 +08:00
- [vimdoc ](https://github.com/google/vimdoc ): Vim help file generator
- [spacemacs ](https://www.spacemacs.org/ ): A community-driven Emacs distribution
2019-01-16 23:34:39 +08:00
- Authors of all the plugins used in SpaceVim.
2017-12-21 20:23:03 +08:00
<!-- vim:set nowrap: -->
