mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-23 13:10:04 +08:00
Improve readme
This commit is contained in:
wsdjeg
parent
bbcf120c91
commit
fe629b3402
@ -26,5 +26,7 @@ else
|
||||
if [ "$LINT" = "jekyll" ]; then
|
||||
./wiki/async.sh "en"
|
||||
./wiki/async.sh "cn"
|
||||
git remote add gitee https://SpaceVimBot:${BOTSECRET}@gitee.com/spacevim/SpaceVim.git
|
||||
git push gitee master
|
||||
fi
|
||||
fi
|
||||
|
||||
79
README.md
79
README.md
@ -16,55 +16,60 @@
|
||||
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Average time to resolve an issue")
|
||||
[](http://isitmaintained.com/project/SpaceVim/SpaceVim "Percentage of issues still open")
|
||||
|
||||
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!
|
||||
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. This
|
||||
approach helps keep configuration organized and reduces overhead for the user by keeping them
|
||||
from having to think about what packages to install.
|
||||
|
||||
|
||||
|
||||
See the [Quick start guide](https://spacevim.org/quick-start-guide), [documentation](https://spacevim.org/documentation) or [the list of layers](http://spacevim.org/layers/) for more information.
|
||||
See the [quick start guide](https://spacevim.org/quick-start-guide), [documentation](https://spacevim.org/documentation) or the [available 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)
|
||||
|
||||
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
|
||||
- [Features](#features)
|
||||
- [Requirements](#requirements)
|
||||
- [Install](#install)
|
||||
- [Linux and macOS](#linux-and-macos)
|
||||
- [Windows](#windows)
|
||||
- [Project layout](#project-layout)
|
||||
- [Blogs](#blogs)
|
||||
- [Support SpaceVim](#support-spacevim)
|
||||
- [Credits & Thanks](#credits--thanks)
|
||||
|
||||
<!-- vim-markdown-toc -->
|
||||
|
||||
### Features
|
||||
## Features
|
||||
|
||||
- **Great documentation:** access documentation in Vim with <kbd>SPC h SPC</kbd>.
|
||||
|
||||
- **Beautiful UI:** you'll love the awesome UI and its useful features.
|
||||
|
||||
- **Mnemonic key bindings:** all key bindings have mnemonic prefixes.
|
||||
|
||||
- **Describe key bindings:** use <kbd>SPC h d k</kbd> to describe key bindings, and find definition of key bindings.
|
||||
|
||||
- **Lazy load plugins:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim)
|
||||
|
||||
- **Awesome statusline:** a heavily customized modular statusline.
|
||||
|
||||
- **Neovim centric:** Dark powered mode of SpaceVim
|
||||
[**Mnemonic key bindings navigation**](http://spacevim.org/mnemonic-key-bindings-navigation/)
|
||||
|
||||
### Requirements
|
||||
You don't need to remember any key bindings, as the mapping guide will show up after the <kbd>SPC</kbd> is pressed.
|
||||
The mapping guide is also available for `g`, `z`, `s`, `f` and `F`.
|
||||
|
||||
|
||||
|
||||
[**Help description for key bindings**](http://spacevim.org/help-description-for-key-bindings/)
|
||||
|
||||
use <kbd>SPC h d k</kbd> to get the help description of a key binding, and `gd` to find definition of key bindings.
|
||||
|
||||
|
||||
|
||||
[**Asynchronous plugin manager**](http://spacevim.org/Asynchronous-plugin-manager/)
|
||||
|
||||
create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asynchronous vim plugin manager
|
||||
|
||||
|
||||
|
||||
For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/)
|
||||
|
||||
## Install
|
||||
|
||||
At a minimum, SpaceVim requires `git` to be installed. For a better graphical experience, install [nerd-font](https://github.com/ryanoasis/nerd-fonts) and make sure your terminal supports [true colors](https://gist.github.com/XVilka/8346728).
|
||||
|
||||
### Install
|
||||
|
||||
#### Linux and macOS
|
||||
### Linux and macOS
|
||||
|
||||
```bash
|
||||
curl -sLf https://spacevim.org/install.sh | bash
|
||||
@ -78,11 +83,11 @@ For more info about the install script, please check:
|
||||
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
|
||||
```
|
||||
|
||||
#### Windows
|
||||
### Windows
|
||||
|
||||
The easist way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually.
|
||||
|
||||
### Project layout
|
||||
## Project layout
|
||||
|
||||
```txt
|
||||
├─ autoload/SpaceVim/api/ APIs
|
||||
@ -90,25 +95,20 @@ The easist way is to download [install.cmd](https://spacevim.org/install.cmd) an
|
||||
├─ autoload/SpaceVim/plugins/ plugins
|
||||
├─ autoload/SpaceVim/mapping/ mapping guide
|
||||
├─ doc/SpaceVim.txt help
|
||||
├─ docs/ website
|
||||
├─ wiki/ wiki
|
||||
├─ docs/ website(cn/en)
|
||||
├─ wiki/ wiki(cn/en)
|
||||
├─ bin/ executeable
|
||||
└─ test/ tests
|
||||
```
|
||||
|
||||
|
||||
### Blogs
|
||||
## Support SpaceVim
|
||||
|
||||
- [Use Vim as a Java IDE](http://spacevim.org/use-vim-as-a-java-ide/)
|
||||
- [An async code runner in SpaceVim](http://spacevim.org/async-code-runner-in-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.
|
||||
|
||||
More posts are in the [SpaceVim's Blog](https://spacevim.org/blog/)
|
||||
|
||||
### 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 buy a drink for the maintainer by clicking following icon.
|
||||
If you want to show your support financially you can 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>
|
||||
|
||||
@ -118,10 +118,11 @@ If you want to show your support financially you can buy a drink for the maintai
|
||||
|
||||
Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv
|
||||
|
||||
### Credits & Thanks
|
||||
## Credits & Thanks
|
||||
|
||||
- [](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
|
||||
- [@Gabirel](https://github.com/Gabirel) and his [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim)
|
||||
- [@everettjf](https://github.com/everettjf) and his [SpaceVimTutorial](https://everettjf.gitbooks.io/spacevimtutorial/content/)
|
||||
- [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
|
||||
|
||||
@ -7,3 +7,39 @@ comments: true
|
||||
---
|
||||
|
||||
# Mnemonic key bindings navigation
|
||||
|
||||
You don't need to remember any key bindings, as a guide buffer is displayed each time the prefix key is pressed
|
||||
in normal/visual mode. It lists the available key bindings and their short description.
|
||||
|
||||
The prefix can be `[SPC]`, `[Window]`, `[denite]`, `<leader>` and `[unite]`, when the guide is opened, you can
|
||||
see the prefix on the statusline.
|
||||
|
||||
|
||||
|
||||
## default key binding prefixes
|
||||
|
||||
| Prefix name | custom option and default value | description |
|
||||
| ----------- | --------------------------------- | ----------------------------------- |
|
||||
| `[SPC]` | NONE / `<Space>` | default mapping prefix of SpaceVim |
|
||||
| `[Window]` | `g:spacevim_windows_leader` / `s` | window mapping prefix of SpaceVim |
|
||||
| `[denite]` | `g:spacevim_denite_leader` / `F` | denite mapping prefix of SpaceVim |
|
||||
| `[unite]` | `g:spacevim_unite_leader` / `f` | unite mapping prefix of SpaceVim |
|
||||
| `<leader>` | `mapleader` / `` \ `` | default leader prefix of vim/neovim |
|
||||
|
||||
By default the guide buffer will be displayed 1000ms after the key has been pressed. You can change the delay by setting `'timeoutlen'` option to your liking (the value is in milliseconds).
|
||||
|
||||
for example, after pressing `<Space>` in normal mode, you will see :
|
||||
|
||||
|
||||
|
||||
this guide show you all the available key bindings begin with `[SPC]`, you can type `b` for all the buffer mappings, `p` for project mappings, etc.
|
||||
|
||||
## Get paging and help info
|
||||
|
||||
after pressing `<C-h>` in guide buffer, you will get paging and help info in the statusline.
|
||||
|
||||
| key | description |
|
||||
| --- | ----------------------------- |
|
||||
| `u` | undo pressing |
|
||||
| `n` | next page of guide buffer |
|
||||
| `p` | previous page of guide buffer |
|
||||
|
||||
@ -6,8 +6,11 @@ image: https://user-images.githubusercontent.com/13142418/34907415-c2cf7e88-f843
|
||||
comments: true
|
||||
---
|
||||
|
||||
# Mnemonic key bindings navigation
|
||||
# Help description for key bindings
|
||||
|
||||
Use `SPC h d k` to start a input prompt, Then press the key bindings you want to describe.
|
||||
|
||||
|
||||
|
||||
sometimes, you want to know the help description of a key binding and the definition of this key binding. this feature help you to quick get
|
||||
these info.
|
||||
|
||||
@ -13,7 +13,7 @@ lang: cn
|
||||
- [可移植性](#可移植性)
|
||||
- [字符串](#字符串)
|
||||
- [匹配字符串](#匹配字符串)
|
||||
- [正则表达式](#正则表达式)
|
||||
- [Regular Expressions](#regular-expressions)
|
||||
- [危险命令](#危险命令)
|
||||
- [脆弱命令](#脆弱命令)
|
||||
- [捕获异常](#捕获异常)
|
||||
@ -25,7 +25,7 @@ lang: cn
|
||||
- [插件布局](#插件布局)
|
||||
- [功能](#功能)
|
||||
- [命令](#命令)
|
||||
- [自动命令](#autocommands)
|
||||
- [自动命令](#自动命令)
|
||||
- [映射](#映射)
|
||||
- [错误](#错误)
|
||||
- [设置](#设置)
|
||||
@ -40,13 +40,13 @@ lang: cn
|
||||
|
||||
## Commit emoji 规范
|
||||
|
||||
- :memo: 添加一个备注或者文档
|
||||
- :gift: 新的特新
|
||||
- :bug: bug 修复
|
||||
- :bomb: 破坏向后兼容
|
||||
- :white_check_mark: 添加测试
|
||||
- :fire: 移除某些配置
|
||||
- :beer: 代码优化
|
||||
- `:memo:` 添加一个备注或者文档
|
||||
- `:gift:` 新的特新
|
||||
- `:bug:` bug 修复
|
||||
- `:bomb:` 破坏向后兼容
|
||||
- `:white_check_mark:` 添加测试
|
||||
- `:fire:` 移除某些配置
|
||||
- `:beer:` 代码优化
|
||||
|
||||
## vim 脚本代码规范
|
||||
|
||||
|
||||
@ -9,20 +9,20 @@ lang: cn
|
||||
<!-- vim-markdown-toc GFM -->
|
||||
|
||||
- [寻求帮助](#寻求帮助)
|
||||
- [Reporting issues](#反馈错误)
|
||||
- [Contributing code](#contributing-code)
|
||||
- [License](#license)
|
||||
- [Conventions](#conventions)
|
||||
- [反馈问题](#反馈问题)
|
||||
- [贡献代码](#贡献代码)
|
||||
- [证书](#证书)
|
||||
- [公约](#公约)
|
||||
- [Pull Request](#pull-request)
|
||||
- [Rebase your pr Branch on top of upstream master:](#rebase-your-pr-branch-on-top-of-upstream-master)
|
||||
- [Ideally for simple PRs (most of them):](#ideally-for-simple-prs-most-of-them)
|
||||
- [For complex PRs (big refactoring, etc):](#for-complex-prs-big-refactoring-etc)
|
||||
- [Contributing a layer](#contributing-a-layer)
|
||||
- [File header](#file-header)
|
||||
- [Author of a new layer](#author-of-a-new-layer)
|
||||
- [Contributor to an existing layer](#contributor-to-an-existing-layer)
|
||||
- [Contributing a keybinding](#contributing-a-keybinding)
|
||||
- [Language specified key bindings](#language-specified-key-bindings)
|
||||
- [在上游的主分支顶部压缩你的PR分支](#在上游的主分支顶部压缩你的pr分支)
|
||||
- [抽象化的简单 PRs(绝大多数PRs都是这样的):](#抽象化的简单-prs绝大多数prs都是这样的)
|
||||
- [复杂的PRs (大的重构, 等):](#复杂的prs-大的重构-等)
|
||||
- [Contributing a layer 贡献层](#contributing-a-layer-贡献层)
|
||||
- [文件头](#文件头)
|
||||
- [新layer的作者](#新layer的作者)
|
||||
- [对现有的layer进行贡献](#对现有的layer进行贡献)
|
||||
- [贡献按键绑定](#贡献按键绑定)
|
||||
- [特定语言的按键绑定](#特定语言的按键绑定)
|
||||
- [Contributing a banner](#contributing-a-banner)
|
||||
- [Build with SpaceVim](#build-with-spacevim)
|
||||
- [Changelog](#changelog)
|
||||
|
||||
@ -39,13 +39,13 @@ description: "conventions of contributing to SpaceVim, including the coding styl
|
||||
|
||||
## Commit emoji convention
|
||||
|
||||
- :memo: Add comment or doc
|
||||
- :gift: New feature.
|
||||
- :bug: Bug fix
|
||||
- :bomb: Breaking compatibility.
|
||||
- :white_check_mark: Write test.
|
||||
- :fire: Remove something.
|
||||
- :beer: I'm happy like reduced code complexity.
|
||||
- `:memo:` Add comment or doc
|
||||
- `:gift:` New feature.
|
||||
- `:bug:` Bug fix
|
||||
- `:bomb:` Breaking compatibility.
|
||||
- `:white_check_mark:` Write test.
|
||||
- `:fire:` Remove something.
|
||||
- `:beer:` I'm happy like reduced code complexity.
|
||||
|
||||
## Viml coding style guide
|
||||
|
||||
|
||||
@ -665,12 +665,12 @@ The prefix can be `[SPC]`, `[Window]`, `[denite]`, `<leader>` and `[unite]`.
|
||||
The default key of these prefix is:
|
||||
|
||||
| Prefix name | custom option and default value | description |
|
||||
| ----------- | --------------------------------------------------------------------------- | ---------------------------------- |
|
||||
| ----------- | --------------------------------- | ----------------------------------- |
|
||||
| `[SPC]` | NONE / `<Space>` | default mapping prefix of SpaceVim |
|
||||
| `[Window]` | `g:spacevim_windows_leader` / `s` | window mapping prefix of SpaceVim |
|
||||
| `[denite]` | `g:spacevim_denite_leader` / `F` | denite mapping prefix of SpaceVim |
|
||||
| `[unite]` | `g:spacevim_unite_leader` / `f` | unite mapping prefix of SpaceVim |
|
||||
| `<leader>` | `mapleader` / `\` \| default leader prefix of vim/neovim | |
|
||||
| `<leader>` | `mapleader` / `` \ `` | default leader prefix of vim/neovim |
|
||||
|
||||
By default the guide buffer will be displayed 1000ms after the key has been pressed. You can change the delay by setting `'timeoutlen'` option to your liking (the value is in milliseconds).
|
||||
|
||||
@ -678,7 +678,9 @@ for example, after pressing `<Space>` in normal mode, you will see :
|
||||
|
||||
|
||||
|
||||
this guide show you all the available key bindings begin with `[SPC]`, you can type `b` for all the buffer mappings, `p` for project mappings, etc. after pressing `<C-h>` in guide buffer, you will get paging and help info in the statusline.
|
||||
this guide show you all the available key bindings begin with `[SPC]`, you can type `b` for all the buffer mappings, `p` for project mappings, etc.
|
||||
|
||||
after pressing `<C-h>` in guide buffer, you will get paging and help info in the statusline.
|
||||
|
||||
| key | description |
|
||||
| --- | ----------------------------- |
|
||||
@ -1579,26 +1581,27 @@ Use `svc` to open a file in the existing Vim server, or using `nsvc` to open a f
|
||||
|
||||
|
||||
<!-- SpaceVim Achievements start -->
|
||||
|
||||
## Achievements
|
||||
|
||||
### issues
|
||||
|
||||
Achievements | Account
|
||||
----- | -----
|
||||
[100th issue(issue)](https://github.com/SpaceVim/SpaceVim/issues/100) | [BenBergman](https://github.com/BenBergman)
|
||||
[1000th issue(PR)](https://github.com/SpaceVim/SpaceVim/issues/1000) | [sei40kr](https://github.com/sei40kr)
|
||||
| Achievements | Account |
|
||||
| --------------------------------------------------------------------- | ------------------------------------------- |
|
||||
| [100th issue(issue)](https://github.com/SpaceVim/SpaceVim/issues/100) | [BenBergman](https://github.com/BenBergman) |
|
||||
| [1000th issue(PR)](https://github.com/SpaceVim/SpaceVim/issues/1000) | [sei40kr](https://github.com/sei40kr) |
|
||||
|
||||
### Stars, forks and watchers
|
||||
|
||||
Achievements | Account
|
||||
----- | -----
|
||||
First stargazers | [monkeydterry](https://github.com/monkeydterry)
|
||||
100th stargazers | [ShaneDelmore](https://github.com/ShaneDelmore)
|
||||
1000th stargazers | [dongkui0712](https://github.com/dongkui0712)
|
||||
2000th stargazers | [EvgeneOskin](https://github.com/EvgeneOskin)
|
||||
3000th stargazers | [zerdon](https://github.com/zerdon)
|
||||
4000th stargazers | [sfwatergit](https://github.com/sfwatergit)
|
||||
5000th stargazers | [robgrzel](https://github.com/robgrzel)
|
||||
| Achievements | Account |
|
||||
| ----------------- | ----------------------------------------------- |
|
||||
| First stargazers | [monkeydterry](https://github.com/monkeydterry) |
|
||||
| 100th stargazers | [ShaneDelmore](https://github.com/ShaneDelmore) |
|
||||
| 1000th stargazers | [dongkui0712](https://github.com/dongkui0712) |
|
||||
| 2000th stargazers | [EvgeneOskin](https://github.com/EvgeneOskin) |
|
||||
| 3000th stargazers | [zerdon](https://github.com/zerdon) |
|
||||
| 4000th stargazers | [sfwatergit](https://github.com/sfwatergit) |
|
||||
| 5000th stargazers | [robgrzel](https://github.com/robgrzel) |
|
||||
|
||||
<!-- SpaceVim Achievements end -->
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user