1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 12:50:04 +08:00

Doc: fix typos. (#2481)

This commit is contained in:
ssfjhh 2019-01-22 07:50:55 +08:00 committed by Wang Shidong
parent 472b71c085
commit f5c8244f2c
13 changed files with 719 additions and 726 deletions

View File

@ -11,6 +11,6 @@ permalink: /404
{% else %}
## Oops! The page you requested was not found!
> you can go to [home](https://spacevim.org) or checkout [Blogs](https://spacevim.org/blog/)
> You can go to [home](https://spacevim.org) or checkout [Blogs](https://spacevim.org/blog/)
{% endif %}

View File

@ -5,14 +5,14 @@ description: "SpaceVim is a community-driven vim distribution with layer feature
# About
[SpaceVim](https://github.com/SpaceVim/SpaceVim) is a community-driven vim distribution with layer feature.
[SpaceVim](https://github.com/SpaceVim/SpaceVim) is a community-driven Vim distribution with layer feature.
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. It got inspired by spacemacs.
### Goals
- more IDE-like features in vim and neovim
- better default different languages
- More IDE-like features in Vim and Neovim
- Better default different languages
### Credits & Thanks

View File

@ -14,8 +14,8 @@ description: "A list of available APIs in SpaceVim, provide compatible functions
#### Introduction
SpaceVim provides many public apis, you can use this apis in your plugins.
This is an example for how to load API, and how to use the public functions within the APIs.
SpaceVim provides many public APIs, you can use these APIs in your plugins.
The following example shows how to load APIs, and how to use the public functions within the APIs.
```vim
" use SpaceVim#api#import() to load the API
@ -36,7 +36,7 @@ echom s:file.pathSeparator
## Available APIs
here is the list of all available APIs, and welcome to contribute to SpaceVim.
Here is the list of all available APIs, and welcome to contribute to SpaceVim.
| Name | Description |
| ------------------------------------- | -------------------------------------------------------------------------------------------------- |

View File

@ -6,7 +6,7 @@ description: "A list of latest blog about the feature of SpaceVim and tutorials
# Blog
Here you can learn more about SpaceVim with our tutorials and find out what's
going on. feel free to [feed this blog via RSS](../../feed.xml)
going on. Feel free to [feed this blog via RSS](../../feed.xml)
<ul>
{% for post in site.categories.blog %}

View File

@ -33,7 +33,7 @@ Visit these resources for help or general questions.
### Chat
All of these channels are bridged together. Click on one of the badges
below to join the chat, In all of these channels, messages from
below to join the chat. In all of these channels, messages from
`SpaceVimBot` is sent by remote user, and the format of the remote
messages is:

View File

@ -39,9 +39,9 @@ description: "conventions of contributing to SpaceVim, including the coding styl
## Commit emoji convention
- `:memo:` Add comment or doc
- `:memo:` Add comment or doc.
- `:gift:` New feature.
- `:bug:` Bug fix
- `:bug:` Bug fix.
- `:bomb:` Breaking compatibility.
- `:white_check_mark:` Write test.
- `:fire:` Remove something.
@ -83,7 +83,7 @@ Avoid using :s[ubstitute] as it moves the cursor and prints error messages. Pref
The meaning of the g flag depends upon the gdefault setting. If you do use :substitute you must save gdefault, set it to 0 or 1, perform the substitution, and then restore it.
For many vim commands, functions exist that do the same thing with fewer side effects. See :help functions() for a list of built-in functions.
For many Vim commands, functions exist that do the same thing with fewer side effects. See `:help functions` for a list of built-in functions.
#### Fragile commands
@ -132,9 +132,9 @@ Use python only when it provides critical functionality, for example when writin
#### Other Languages
**Use vimscript instead.**
**Use Vimscript instead.**
Avoid using other scripting languages such as ruby and lua. We can not guarantee that the end user's vim has been compiled with support for non-vimscript languages.
Avoid using other scripting languages such as ruby and lua. We cannot guarantee that the end user's Vim has been compiled with support for non-vimscript languages.
#### Plugin layout
@ -198,8 +198,7 @@ Use :setlocal and &l: instead of :set and & unless you have explicit reason to d
### Style
Follow google style conventions. When in doubt, treat vimscript style like
python style.
Follow google style conventions. When in doubt, treat vimscript style like python style.
#### Whitespace
@ -247,7 +246,7 @@ such as "noremap <leader>gf :grep -f ".
When continuing a multi-line command a pipe can be substituted for this space as necessary, as follows:
```viml
```vim
autocommand BufEnter <buffer>
\ if !empty(s:var)
\| call some#function()
@ -288,11 +287,11 @@ Always prefix variables with their scope.
## Key notations
- use capital case and angle brackets for keyboard button: `<Down>`, `<Up>`
- use uppercase for custom leader: `SPC`, `WIN`, `UNITE`, `DENITE`
- use space as delimiter for key sequences: `SPC t w`, `<Leader> f f`
- use `/` for alternative sequences: `<Tab>` / `<C-n>`
- Use `Ctrl-e` instead of `<C-e>` in documentation
- Use capital case and angle brackets for keyboard buttons: `<Down>`, `<Up>`.
- Use uppercase for custom leader: `SPC`, `WIN`, `UNITE`, `DENITE`.
- Use space as delimiter for key sequences: `SPC t w`, `<Leader> f f`.
- Use `/` for alternative sequences: `<Tab>` / `<C-n>`.
- Use `Ctrl-e` rather than `<C-e>` in documentation.
## Thanks:

View File

@ -30,10 +30,10 @@ description: "General contributing guidelines and changelog of SpaceVim, includi
<!-- vim-markdown-toc -->
SpaceVim is an effort of all the volunteers, we encourage you to pitch in. The community makes SpaceVim what it is.
We have a few guidelines, which we ask all contributors to follow.
SpaceVim is an effort of all the volunteers. We encourage you to pitch in. The community makes SpaceVim what it is.
We have a few guidelines which we need all contributors to follow.
Development happens in the GitHub repository. here is a throughput graph of the repository for the last few weeks:
Development happens in the GitHub repository. 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)
@ -52,9 +52,9 @@ If you want to ask an usage question, be sure to look first into some places as
## Reporting issues
Issues have to be reported on [issues tracker](https://github.com/SpaceVim/SpaceVim/issues), Please:
Issues have to be reported on [issues tracker](https://github.com/SpaceVim/SpaceVim/issues), please:
- Check that there is no duplicate issue in the issues tracker, you can search for keywords in the issues tracker.
- Check that no duplicate issue is in the issues tracker, you can search for keywords in the issues tracker.
- Check that the issue has not been fixed in latest version of SpaceVim, please update your SpaceVim, and try to reproduce the bug here.
- Use a clear title and follow the issue template.
- Include details on how to reproduce it, just like a step by step guide.
@ -65,7 +65,7 @@ Code contributions are welcome. Please read the following sections carefully. In
### License
The license is GPLv3 for all the parts of SpaceVim. this includes:
The license is GPLv3 for all the parts of SpaceVim. This includes:
- The initialization and core files.
- All the layer files.
@ -91,32 +91,29 @@ Pull request titles should contain one of these prefix:
- `Add:` Adding a new feature.
- `Change:` Change default behaviors or the existing features.
- `Fixed:` Fix some bugs
- `Fixed:` Fix some bugs.
- `Remove:` Remove any existing features.
- `Doc:` update the help file.
- `Doc:` Update the help file.
- `Website:` Update the content of website.
Here is an example:
`Website: update the lang#c layer page`
`Website: Update the lang#c layer page.`
#### Rebase on top of upstream master
- fork SpaceVim repository
- clone your repository
- Fork SpaceVim repository
- Clone your repository
```sh
git clone ${YOUR_OWN_REPOSITORY_URL}
```
- add upstream remote
- Add upstream remote
```sh
git remote add upstream https://github.com/SpaceVim/SpaceVim.git
```
- fetch upstream and rebase on top of upstream master
- Fetch upstream and rebase on top of upstream master
```sh
git fetch upstream
git rebase upstream/master
@ -132,7 +129,7 @@ git rebase upstream/master
#### For complex PRs
Squash only the commits with uninteresting changes like typos, syntax fixes, etc… and keep the important and isolated steps in different commits.
Squash only the commits with uninteresting changes like typos, syntax fixes, etc. And keep the important and isolated steps in different commits.
Those PRs are merged and explicitly not fast-forwarded.
@ -171,19 +168,19 @@ Further paragraphs come after blank lines.
- Use a hanging indent
```
[Gita] provide vim mode for Git commit messages, which helps you to comply to these guidelines.
[Gita] provide Vim mode for Git commit messages, which helps you to comply to these guidelines.
### Contributing a layer
Please read the layers documentation first.
Layer with no associated configuration will be rejected. For instance a layer with just a package and a hook can be easily replaced by the usage of the variable `g:spacevim_custom_plugins`.
Layer with no associated configuration will be rejected. For instance a layer with just a package and a hook can be easily replaced by the usage of the variable `custom_plugins`.
#### File header
The file header for vim script should look like the following template:
The file header for Vim script should look like the following template:
```viml
```vim
"=============================================================================
" FILENAME --- NAME layer file for SpaceVim
" Copyright (c) 2012-2016 Shidong Wang & Contributors
@ -193,17 +190,17 @@ The file header for vim script should look like the following template:
"=============================================================================
```
You should replace FILENAME by the name of the file (e.g. foo.vim) and NAME by the name of the layer you are creating, dont forget to replace **YOUR NAME** and **YOUR EMAIL** also.
You should replace FILENAME by the name of the file (e.g. foo.vim) and NAME by the name of the layer you are creating, dont forget to replace **YOUR NAME** and **YOUR EMAIL** neighter.
#### Author of a new layer
In the files header, change the default author name (Shidong Wang) to your name.
In the files header, replace the default author name (Shidong Wang) with your name.
Here is an example for creating a new layer names `foo`:
The following example shows how to create a new layer names `foo`:
1. fork SpaceVim repo
2. add a layer file `autoload/SpaceVim/layers/foo.vim` for `foo` layer.
3. edit layer file, check out the example below:
1. Fork SpaceVim repo.
2. Add a layer file `autoload/SpaceVim/layers/foo.vim` for `foo` layer.
3. Edit layer file, check out the example below:
```vim
"=============================================================================
@ -260,28 +257,28 @@ endfunction
4. Add layer document `docs/layers/foo.md` for `foo` layer.
5. Open `docs/layers/index.md`, run `:call SpaceVim#dev#layers#update()` to update layer list.
6. send PR to SpaceVim.
6. Send PR to SpaceVim.
#### Contributor to an existing layer
If you are contributing to an already existing layer, you should not modify any header file.
If you want to contribute to an already existing layer, you should not modify any header file.
#### Contributing a keybinding
Mappings are an important part of SpaceVim.
First if you want to have some personal mappings, This can be done in your `~/.SpaceVim.d/init.vim` file.
First if you want to have some personal mappings. This can be done in your bootstrap function.
If you think it worth contributing a new mappings then be sure to read the documentation to find the best mappings, then create a Pull-Request with your changes.
If you think it worth contributing new mappings, be sure to read the documentation to find the best mappings, then create a Pull-Request with your mappings.
ALWAYS document your new mappings or mappings changes inside the relevant documentation file.
It should be the the layer file and the [documentation](../documentation/).
It should be the layername.md and the [documentation](../documentation/).
##### Language specified key bindings
All language specified key bindings are started with `SPC l` prefix.
All language specified key bindings prefix `SPC l`.
we recommended to keep same language specified key bindings for different languages:
We recommend to keep same language specified key bindings for different languages:
| Key Binding | Description |
| ----------- | ------------------------------------------------ |
@ -295,7 +292,7 @@ we recommended to keep same language specified key bindings for different langua
| `SPC l s l` | send line and keep code buffer focused |
| `SPC l s s` | send selection text and keep code buffer focused |
All of these above key bindings are just recommended as default, but it also base on the language layer itself.
All above key bindings are just recommended as default, but they also base on the language layer itself.
#### Contributing a banner
@ -307,7 +304,7 @@ You are free to choose a reasonable height size but the width size should be aro
## Build with SpaceVim
SpaceVim provide a lot of public [APIs](../api/), you can create plugins base on this APIs. also you can add a badge to the README.md of your plugin.
SpaceVim provide a lot of public [APIs](../api/), you can create plugins base on this APIs. Also you can add a badge to the README.md of your plugin.
![](https://img.shields.io/badge/build%20with-SpaceVim-ff69b4.svg)

File diff suppressed because it is too large Load Diff

View File

@ -5,7 +5,7 @@ description: "A list of questions and answers relating to SpaceVim, especially t
# SpaceVim FAQ
This is a list of the most asked questions about SpaceVim.
This is a list of the frequently asked questions about SpaceVim.
<!-- vim-markdown-toc GFM -->
@ -15,31 +15,31 @@ This is a list of the most asked questions about SpaceVim.
- [E492: Not an editor command: ^M](#e492-not-an-editor-command-m)
- [Why SpaceVim can not display default colorscheme?](#why-spacevim-can-not-display-default-colorscheme)
- [Why can't I update plugins?](#why-cant-i-update-plugins)
- [how to enable +py and +py3 in neovim?](#how-to-enable-py-and-py3-in-neovim)
- [Why does vim freeze after pressing Ctrl-s?](#why-does-vim-freeze-after-pressing-ctrl-s)
- [How to enable +py and +py3 in Neovim?](#how-to-enable-py-and-py3-in-neovim)
- [Why does Vim freeze after pressing Ctrl-s?](#why-does-vim-freeze-after-pressing-ctrl-s)
<!-- vim-markdown-toc -->
### Can I try SpaceVim without overwriting my vimrc?
The SpaceVim install script will move your `~/.vimrc` to `~/.vimrc_back`. If you want to have a try SpaceVim without
overwriting your own vim configuration you can:
overwriting your own Vim configuration you can:
clone SpaceVim manually.
Clone SpaceVim manually.
```sh
git clone https://github.com/SpaceVim/SpaceVim.git ~/.SpaceVim
```
then, start vim via `vim -u ~/.SpaceVim/vimrc`. You can also put this alias into your bashrc.
Then, start Vim via `vim -u ~/.SpaceVim/vimrc`. You can also put this alias into your bashrc.
```sh
alias svim='vim -u ~/.SpaceVim/vimrc'
```
### Why use toml as the default configuration file format?
In the old version of SpaceVim, we used a vim file (`init.vim`) for configuration. This introduced a lot of problems.
When loading a vim file the file content is executed line by line. This means that when there was an error the content
In the old version of SpaceVim, we used a Vim file (`init.vim`) for configuration. This introduced a lot of problems.
When loading a Vim file the file content is executed line by line. This means that when there was an error the content
before the error was still executed. This led to unforeseen problems.
We decided going forward to use a more robust configuration mechanism in SpaceVim. SpaceVim must be able to load the
@ -78,9 +78,9 @@ directory is dirty (has changes that haven't been committed to git) you can not
issue, just move your cursor to the error line, and press `gf`, then run `git reset --hard HEAD` or `git checkout .`. For
more info please read git documentation.
### How to enable +py and +py3 in neovim?
### How to enable +py and +py3 in Neovim?
In neovim we can use `g:python_host_prog` and `g:python3_host_prog` to config python prog. In SpaceVim
In Neovim we can use `g:python_host_prog` and `g:python3_host_prog` to config python prog. In SpaceVim
the custom configuration file is loaded after SpaceVim core code. So in SpaceVim itself, if we using `:py` command, it may cause errors.
So we introduce two new environment variables: `PYTHON_HOST_PROG` and `PYTHON3_HOST_PROG`.
@ -91,9 +91,9 @@ export PYTHON_HOST_PROG='/home/q/envs/neovim2/bin/python'
export PYTHON3_HOST_PROG='/home/q/envs/neovim3/bin/python'
```
### Why does vim freeze after pressing Ctrl-s?
### Why does Vim freeze after pressing Ctrl-s?
This is a [feature of terminal emulators](https://unix.stackexchange.com/a/137846). You can use `Ctrl-q` to unfreeze vim. To disable
This is a [feature of terminal emulators](https://unix.stackexchange.com/a/137846). You can use `Ctrl-q` to unfreeze Vim. To disable
this feature you need the following in either `~/.bash_profile` or `~/.bashrc`:
```sh

View File

@ -12,17 +12,17 @@ description: "SpaceVim is a community-driven vim distribution that seeks to prov
![welcome-page](https://user-images.githubusercontent.com/13142418/50423286-5b33a400-088e-11e9-830c-792ce1c7c126.png)
# SpaceVim - Modern vim distribution
# SpaceVim - Modern Vim distribution
SpaceVim is a distribution of the vim editor that's inspired by spacemacs.
It manages collections of plugins in layers, which help collect related
SpaceVim is a distribution of the Vim editor that's inspired by spacemacs.
It manages collections of plugins in layers, which help collecting related
packages together to provide features. For example, the python layer collects
deoplete.nvim, neomake and jedi-vim together to provide autocompletion,
syntax checking, and documentation lookup. This approach helps keep
syntax checking, and documentation lookup. This approach helps keeping
configuration organized and reduces overhead for the user by keeping them
from having to think about what packages to install.
If you like SpaceVim, feel free to star the project on github. It is a great way to show your
If you like SpaceVim, please feel free to star the project on github. It is a great way to show your
appreciation while providing us motivation to continue working on this project.
@ -64,12 +64,12 @@ for development progress and the [roadmap](roadmap/) for high-level plans.
- 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.
With layers feature, this version of Vim distribution try to turn Vim/Neovim into an IDE for many languages.
- Which version of vim/neovim is needed?
- Which version of Vim/Neovim is needed?
vim 7.4/neovim v0.1.7, and `+lua` or `+python3` is needed.
Vim 7.4/Neovim v0.1.7, and `+lua` or `+python3` is needed.
For more general questions, please read [SpaceVim FAQ](faq/)
For more general questions, please read [SpaceVim FAQ](faq/).
<!-- vim:set nowrap: -->

View File

@ -16,8 +16,8 @@ description: "A guide for managing SpaceVim with layers, tell you how to enable
## Introduction
SpaceVim is a community-driven vim distribution that seeks to provide layer feature.
Layers help collect related packages together to provide features.
SpaceVim is a community-driven Vim distribution that seeks to provide layer feature.
Layers help collecting 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.
@ -38,105 +38,105 @@ By default SpaceVim enable these layers:
To enable a specific layer you need to edit SpaceVim configuration file.
The key binding for opening SpaceVim configuration file is `SPC f v d`.
here is an example for loading `shell` layer with some specified options:
The following example shows how to load `shell` layer with some specified options:
```toml
[[layers]]
name = "shell"
default_position = "top"
default_height = 30
name = "shell"
default_position = "top"
default_height = 30
```
### Disable layers
Some layers are enabled by default, here is an example for disable `shell` layer:
Some layers are enabled by default. The following example shows how to disable `shell` layer:
```toml
[[layers]]
name = "shell"
enable = false
name = "shell"
enable = false
```
<!-- SpaceVim layer list start -->
## Available layers
| Name | Description |
| ---------- | ------------ |
| [VersionControl](VersionControl/) | This layers provides general version control feature for vim. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc… |
| [autocomplete](autocomplete/) | Autocomplete code within SpaceVim, fuzzy find the candidates from multiple completion sources, expand snippet before cursor automatically |
| [chat](chat/) | SpaceVim chatting layer provide chatting with qq and weixin in vim. |
| [checkers](checkers/) | Syntax checking automatically within SpaceVim, display error on the sign column and statusline. |
| [chinese](chinese/) | Layer for chinese users, include chinese docs and runtime messages |
| [colorscheme](colorscheme/) | colorscheme provides a list of colorscheme for SpaceVim, default colorscheme is gruvbox with dark theme. |
| [core#banner](core/banner/) | This layer provides many default banner on welcome page. |
| [core#statusline](core/statusline/) | This layer provides default statusline for SpaceVim |
| [core#tabline](core/tabline/) | SpaceVim core#tabline layer provides a better tabline for SpaceVim |
| [core](core/) | SpaceVim core layer provides many default key bindings and features. |
| [cscope](cscope/) | cscope layer provides a smart cscope and pycscope helper for SpaceVim, help users win at cscope |
| [ctrlp](ctrlp/) | This layers provide a heavily customized ctrlp centric work-flow |
| [debug](debug/) | This layer provide debug workflow support in SpaceVim |
| [default](default/) | SpaceVim default layer contains no plugins, but It provides some better default config for SpaceVim. |
| [denite](denite/) | This layers provide a heavily customized Denite centric work-flow |
| [edit](edit/) | Improve code edit expr in SpaceVim, provide more text opjects. |
| [floobits](floobits/) | This layer adds support for the peer programming tool floobits to SpaceVim. |
| [format](format/) | Code formatting support for SpaceVim |
| [fzf](fzf/) | This layers provide a heavily customized fzf centric work-flow |
| [git](git/) | This layers adds extensive support for git |
| [github](github/) | This layer provides GitHub integration for SpaceVim |
| [japanese](japanese/) | Layer for japanese users, include japanese docs and runtime messages |
| [lang#WebAssembly](lang/WebAssembly/) | This layer adds WebAssembly support to SpaceVim |
| [lang#agda](lang/agda/) | This layer adds agda language support to SpaceVim |
| [lang#asciidoc](lang/asciidoc/) | Edit asciidoc within vim, autopreview asciidoc in the default browser, with this layer you can also format asciidoc file. |
| [lang#autohotkey](lang/autohotkey/) | This layer adds autohotkey language support to SpaceVim |
| [lang#c](lang/c/) | c/c++/object-c language support for SpaceVim, include code completion, jump to definition, quick runner. |
| [lang#clojure](lang/clojure/) | This layer is for clojure development, provide autocompletion, syntax checking, code format for clojure file. |
| [lang#csharp](lang/csharp/) | This layer is for csharp development |
| [lang#dart](lang/dart/) | This layer is for dart development, provide autocompletion, syntax checking, code format for dart file. |
| [lang#dockerfile](lang/dockerfile/) | This layer adds DockerFile to SpaceVim |
| [lang#elixir](lang/elixir/) | This layer is for elixir development, provide autocompletion, syntax checking, code format for elixir file. |
| [lang#elm](lang/elm/) | This layer is for elm development, provide autocompletion, syntax checking, code format for elm file. |
| [lang#erlang](lang/erlang/) | This layer is for erlang development, provide autocompletion, syntax checking, code format for erlang file. |
| [lang#extra](lang/extra/) | This layer adds extra language support to SpaceVim |
| [lang#fsharp](lang/fsharp/) | This layer adds fsharp language support to SpaceVim |
| [lang#go](lang/go/) | This layer is for golang development. It also provides additional language-specific key mappings. |
| [lang#haskell](lang/haskell/) | haskell language support for SpaceVim, includes code completion, syntax checking, jumping to definition, also provides language server protocol support for haskell |
| [lang#html](lang/html/) | Edit html in SpaceVim, with this layer, this layer provides code completion, syntax checking and code formatting for html. |
| [lang#java](lang/java/) | This layer is for Java development. All the features such as code completion, formatting, syntax checking, REPL and debug have be done in this layer. |
| [lang#javascript](lang/javascript/) | This layer is for JavaScript development |
| [lang#julia](lang/julia/) | This layer is for julia development, provide autocompletion, syntax checking and code formatting |
| [lang#kotlin](lang/kotlin/) | This layer adds kotlin language support to SpaceVim |
| [lang#latex](lang/latex/) | This layer provides support for writing LaTeX documents, including syntax highlighting, code completion, formatting etc. |
| [lang#lisp](lang/lisp/) | This layer is for lisp development, provide autocompletion, syntax checking, code format for lisp file. |
| [lang#lua](lang/lua/) | This layer is for lua development, provide autocompletion, syntax checking, code format for lua file. |
| [lang#markdown](lang/markdown/) | Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown file. |
| [lang#nim](lang/nim/) | This layer adds nim language support to SpaceVim |
| [lang#ocaml](lang/ocaml/) | This layer is for ocaml development, provide autocompletion, syntax checking, code format for ocaml file. |
| [lang#perl](lang/perl/) | This layer is for perl development, provide autocompletion, syntax checking, code format for perl file. |
| [lang#php](lang/php/) | This layer adds PHP language support to SpaceVim |
| [lang#plantuml](lang/plantuml/) | This layer is for plantuml development, syntax highlighting for plantuml file. |
| [lang#puppet](lang/puppet/) | This layer adds puppet language support to SpaceVim |
| [lang#purescript](lang/purescript/) | This layer is for purescript development, provide autocompletion, syntax checking, code format for purescript file. |
| [lang#python](lang/python/) | This layer is for Python development, provide autocompletion, syntax checking, code format for python file. |
| [lang#ruby](lang/ruby/) | This layer is for ruby development, provide autocompletion, syntax checking, code format for ruby file. |
| [lang#rust](lang/rust/) | This layer is for rust development, provide autocompletion, syntax checking, code format for rust file. |
| [lang#scala](lang/scala/) | This layer adds scala language support to SpaceVim |
| [lang#scheme](lang/scheme/) | This layer adds scheme language support to SpaceVim |
| [lang#sh](lang/sh/) | Shell script development layer, provides autocompletion, syntax checking, code format for bash and zsh script. |
| [lang#swift](lang/swift/) | swift language support for SpaceVim, includes code completion, syntax highlighting |
| [lang#typescript](lang/typescript/) | This layer is for TypeScript development |
| [lang#vim](lang/vim/) | This layer is for writting vim script, including code completion, syntax checking and buffer formatting |
| [lang#vue](lang/vue/) | This layer adds vue language support to SpaceVim |
| [lsp](language-server-protocol/) | This layers provides language server protocol for vim and neovim |
| [leaderf](leaderf/) | This layers provide a heavily customized LeaderF centric work-flow |
| [shell](shell/) | This layer provide shell support in SpaceVim |
| [sudo](sudo/) | sudo layer provides ability to read and write file elevated privileges in SpaceVim |
| [tags](tags/) | This layer provide tags manager for project |
| [tests](tests/) | This layer allows to run tests directly on SpaceVim |
| [tmux](tmux/) | This layers adds extensive support for tmux |
| [tools#dash](tools/dash/) | This layer provides Dash integration for SpaceVim |
| [tools](tools/) | This layer provides some tools for vim |
| [ui](ui/) | Awesome UI layer for SpaceVim, provide IDE-like UI for neovim and vim in both TUI and GUI |
| Name | Description |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [autocomplete](autocomplete/) | Autocomplete code within SpaceVim, fuzzy find the candidates from multiple completion sources, expand snippet before cursor automatically |
| [chat](chat/) | SpaceVim chatting layer provide chatting with qq and weixin in vim. |
| [checkers](checkers/) | Syntax checking automatically within SpaceVim, display error on the sign column and statusline. |
| [chinese](chinese/) | Layer for chinese users, include chinese docs and runtime messages |
| [colorscheme](colorscheme/) | colorscheme provides a list of colorscheme for SpaceVim, default colorscheme is gruvbox with dark theme. |
| [core#banner](core/banner/) | This layer provides many default banner on welcome page. |
| [core#statusline](core/statusline/) | This layer provides default statusline for SpaceVim |
| [core#tabline](core/tabline/) | SpaceVim core#tabline layer provides a better tabline for SpaceVim |
| [core](core/) | SpaceVim core layer provides many default key bindings and features. |
| [cscope](cscope/) | cscope layer provides a smart cscope and pycscope helper for SpaceVim, help users win at cscope |
| [ctrlp](ctrlp/) | This layers provide a heavily customized ctrlp centric work-flow |
| [debug](debug/) | This layer provide debug workflow support in SpaceVim |
| [default](default/) | SpaceVim default layer contains no plugins, but It provides some better default config for SpaceVim. |
| [denite](denite/) | This layers provide a heavily customized Denite centric work-flow |
| [edit](edit/) | Improve code edit expr in SpaceVim, provide more text opjects. |
| [floobits](floobits/) | This layer adds support for the peer programming tool floobits to SpaceVim. |
| [format](format/) | Code formatting support for SpaceVim |
| [fzf](fzf/) | This layers provide a heavily customized fzf centric work-flow |
| [git](git/) | This layers adds extensive support for git |
| [github](github/) | This layer provides GitHub integration for SpaceVim |
| [japanese](japanese/) | Layer for japanese users, include japanese docs and runtime messages |
| [lang#agda](lang/agda/) | This layer adds agda language support to SpaceVim |
| [lang#asciidoc](lang/asciidoc/) | Edit asciidoc within vim, autopreview asciidoc in the default browser, with this layer you can also format asciidoc file. |
| [lang#autohotkey](lang/autohotkey/) | This layer adds autohotkey language support to SpaceVim |
| [lang#c](lang/c/) | c/c++/object-c language support for SpaceVim, include code completion, jump to definition, quick runner. |
| [lang#clojure](lang/clojure/) | This layer is for clojure development, provide autocompletion, syntax checking, code format for clojure file. |
| [lang#csharp](lang/csharp/) | This layer is for csharp development |
| [lang#dart](lang/dart/) | This layer is for dart development, provide autocompletion, syntax checking, code format for dart file. |
| [lang#dockerfile](lang/dockerfile/) | This layer adds DockerFile to SpaceVim |
| [lang#elixir](lang/elixir/) | This layer is for elixir development, provide autocompletion, syntax checking, code format for elixir file. |
| [lang#elm](lang/elm/) | This layer is for elm development, provide autocompletion, syntax checking, code format for elm file. |
| [lang#erlang](lang/erlang/) | This layer is for erlang development, provide autocompletion, syntax checking, code format for erlang file. |
| [lang#extra](lang/extra/) | This layer adds extra language support to SpaceVim |
| [lang#fsharp](lang/fsharp/) | This layer adds fsharp language support to SpaceVim |
| [lang#go](lang/go/) | This layer is for golang development. It also provides additional language-specific key mappings. |
| [lang#haskell](lang/haskell/) | haskell language support for SpaceVim, includes code completion, syntax checking, jumping to definition, also provides language server protocol support for haskell |
| [lang#html](lang/html/) | Edit html in SpaceVim, with this layer, this layer provides code completion, syntax checking and code formatting for html. |
| [lang#java](lang/java/) | This layer is for Java development. All the features such as code completion, formatting, syntax checking, REPL and debug have be done in this layer. |
| [lang#javascript](lang/javascript/) | This layer is for JavaScript development |
| [lang#julia](lang/julia/) | This layer is for julia development, provide autocompletion, syntax checking and code formatting |
| [lang#kotlin](lang/kotlin/) | This layer adds kotlin language support to SpaceVim |
| [lang#latex](lang/latex/) | This layer provides support for writing LaTeX documents, including syntax highlighting, code completion, formatting etc. |
| [lang#lisp](lang/lisp/) | This layer is for lisp development, provide autocompletion, syntax checking, code format for lisp file. |
| [lang#lua](lang/lua/) | This layer is for lua development, provide autocompletion, syntax checking, code format for lua file. |
| [lang#markdown](lang/markdown/) | Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown file. |
| [lang#nim](lang/nim/) | This layer adds nim language support to SpaceVim |
| [lang#ocaml](lang/ocaml/) | This layer is for ocaml development, provide autocompletion, syntax checking, code format for ocaml file. |
| [lang#perl](lang/perl/) | This layer is for perl development, provide autocompletion, syntax checking, code format for perl file. |
| [lang#php](lang/php/) | This layer adds PHP language support to SpaceVim |
| [lang#plantuml](lang/plantuml/) | This layer is for plantuml development, syntax highlighting for plantuml file. |
| [lang#puppet](lang/puppet/) | This layer adds puppet language support to SpaceVim |
| [lang#purescript](lang/purescript/) | This layer is for purescript development, provide autocompletion, syntax checking, code format for purescript file. |
| [lang#python](lang/python/) | This layer is for Python development, provide autocompletion, syntax checking, code format for python file. |
| [lang#ruby](lang/ruby/) | This layer is for ruby development, provide autocompletion, syntax checking, code format for ruby file. |
| [lang#rust](lang/rust/) | This layer is for rust development, provide autocompletion, syntax checking, code format for rust file. |
| [lang#scala](lang/scala/) | This layer adds scala language support to SpaceVim |
| [lang#scheme](lang/scheme/) | This layer adds scheme language support to SpaceVim |
| [lang#sh](lang/sh/) | Shell script development layer, provides autocompletion, syntax checking, code format for bash and zsh script. |
| [lang#swift](lang/swift/) | swift language support for SpaceVim, includes code completion, syntax highlighting |
| [lang#typescript](lang/typescript/) | This layer is for TypeScript development |
| [lang#vim](lang/vim/) | This layer is for writting vim script, including code completion, syntax checking and buffer formatting |
| [lang#vue](lang/vue/) | This layer adds vue language support to SpaceVim |
| [lang#WebAssembly](lang/WebAssembly/) | This layer adds WebAssembly support to SpaceVim |
| [leaderf](leaderf/) | This layers provide a heavily customized LeaderF centric work-flow |
| [lsp](language-server-protocol/) | This layers provides language server protocol for vim and neovim |
| [shell](shell/) | This layer provide shell support in SpaceVim |
| [sudo](sudo/) | sudo layer provides ability to read and write file elevated privileges in SpaceVim |
| [tags](tags/) | This layer provide tags manager for project |
| [tests](tests/) | This layer allows to run tests directly on SpaceVim |
| [tmux](tmux/) | This layers adds extensive support for tmux |
| [tools#dash](tools/dash/) | This layer provides Dash integration for SpaceVim |
| [tools](tools/) | This layer provides some tools for vim |
| [ui](ui/) | Awesome UI layer for SpaceVim, provide IDE-like UI for neovim and vim in both TUI and GUI |
| [VersionControl](VersionControl/) | This layers provides general version control feature for vim. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc… |
<!-- SpaceVim layer list end -->

View File

@ -23,10 +23,10 @@ show you how to install it, how to config it, and explain its features.
## Install
At a minimum, SpaceVim requires `git` and `curl` to be installed. These tools
At a minimum, SpaceVim requires `git` and `curl` to be installed. Both tools
are needed for downloading plugins and fonts.
If you are using vim/neovim in terminal, you also need to set the font of your terminal.
If you are using Vim/Neovim in terminal, you also need to set the font of your terminal.
### Linux and macOS
@ -34,7 +34,7 @@ If you are using vim/neovim in terminal, you also need to set the font of your t
curl -sLf https://spacevim.org/install.sh | bash
```
After SpaceVim is installed, launch `vim` and SpaceVim will **automatically** install plugins.
After SpaceVim being installed, launch `vim` and SpaceVim will **automatically** install plugins.
For more info about the install script, please check:
@ -53,7 +53,7 @@ docker pull spacevim/spacevim
docker run -it --rm spacevim/spacevim nvim
```
you can also load local config:
You can also load local config:
```sh
docker run -it -v ~/.SpaceVim.d:/home/spacevim/.SpaceVim.d --rm spacevim/spacevim nvim
@ -66,9 +66,9 @@ an example for basic usage of SpaceVim. For more info, please checkout SpaceVim
documentation.
```toml
# This is basic configuration example for SpaceVim
# This is a basic configuration example for SpaceVim
# All SpaceVim options are below [options] section
# All SpaceVim options are below [options] snippet
[options]
# set spacevim theme. by default colorscheme layer is not loaded,
# if you want to use more colorscheme, please load the colorscheme
@ -92,19 +92,19 @@ documentation.
# Enable autocomplete layer
[[layers]]
name = "autocomplete"
auto-completion-return-key-behavior = "complete"
auto-completion-tab-key-behavior = "cycle"
name = "autocomplete"
auto-completion-return-key-behavior = "complete"
auto-completion-tab-key-behavior = "cycle"
[[layers]]
name = "shell"
default_position = "top"
default_height = 30
name = "shell"
default_position = "top"
default_height = 30
# This is an example for adding custom plugins lilydjwg/colorizer
[[custom_plugins]]
name = "lilydjwg/colorizer"
merged = 0
name = "lilydjwg/colorizer"
merged = false
```
## Online tutor
@ -113,7 +113,7 @@ This is a list of online tutor for using SpaceVim as general IDE and programming
- [use vim as general IDE](../use-vim-as-ide/): a general guide for using SpaceVim as IDE
a list of guide for programming language support:
A list of guide for programming language support:
<ul>

View File

@ -1,6 +1,6 @@
---
title: "Sponsors"
description: "the companies or individuals contributing a monthly amount to help sustain SpaceVim's development."
description: "The companies or individuals contributing a monthly amount to help sustain SpaceVim's development."
---
# Sponsors
@ -25,77 +25,77 @@ Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv
These are the companies or individuals contributing a monthly amount to help sustain SpaceVim's development.
See the [Bountysource campaign](https://www.bountysource.com/teams/spacevim) for more details.
| date     | Amount | Description                                   |
| ------------ | ------- | --------------------------------------------- |
| 2016-09-26 | ¥ 100 | *好 |
| 2016-09-26 | ¥ 300 | *好 |
| 2016-11-22 | ¥ 20 | *续 |
| 2017-02-23 | ¥ 40 | *拔 |
| 2017-02-14 | ¥ 100 | *洁 |
| 2017-03-18 | ¥ 20 | z*t |
| 2017-03-30 | ¥ 20 | l*n |
| 2017-04-07 | ¥ 20 | *酱 |
| 2017-06-20 | $ 2.57 | Шепелев Григорий |
| 2017-06-24 | $ 14.04 | Vowell Jason |
| 2017-06-24 | $ 2.57 | Senaud Nicolas |
| 2017-09-16 | $ 2.57 | D'Avezac Mayeul |
| 2017-09-24 | ¥ 0.99 | 1*5 |
| 2017-11-02 | ¥ 10 | *下 |
| 2017-11-02 | ¥ 10 | *下 |
| 2017-11-20 | ¥ 1.6 | *瑞 |
| 2017-11-26 | $ 14.04 | Hermans Tim |
| 2017-12-13 | $ 5.44 | Ma Fei |
| 2017-12-27 | $ 8.30 | Módolo Marcelo |
| 2017-12-28 | ¥ 20 | s*n |
| 2017-12-28   | ¥ 10.24 | bts |
| 2017-12-29 | ¥ 10 | *哥 |
| 2018-01-22 | ¥ 10 | *强 |
| 2018-01-24 | ¥ 20 | unlockingc |
| 2018-02-05 | $ 2.57 | Samuel Mitchell |
| 2018-02-13 | $ 45 | talktopete |
| 2018-02-14 | ¥ 20 | *川 |
| 2018-02-14 | ¥ 188 | *黑8 |
| 2018-02-18 | ¥ 66.6 | *谨 |
| 2018-02-22 | $ 9 | sei40kr |
| 2018-02-24 | $ 6 | kapkabnh |
| 2018-03-14 | ¥ 1 | *目 |
| 2018-03-20 | $ 10 | kovaski |
| 2018-03-26 | ¥ 0.01 | *丰 |
| 2018-03-28 | $ 2.57 | 小林 |
| 2018-03-30 | ¥ 10 | 林* |
| 2018-03-31 | ¥ 18.88 | s*n |
| 2018-04-04 | ¥ 10 | 童* |
| 2018-04-06 | ¥ 9.99 | Galaxy |
| 2018-04-20 | ¥ 5 | 可*) |
| 2018-04-29 | ¥ 5 | *中 |
| 2018-05-07 | ¥ 6.6 | *浪 |
| 2018-05-09 | ¥ 10 | S*R |
| 2018-05-16 | $ 2.57 | Daniel Beste |
| 2018-06-18 | $ 11.17 | Charalambos |
| 2018-06-20 | $ 2.57 | Jingpeng Wu |
| 2018-06-24 | ¥ 50 | 青* |
| 2018-06-25 | $ 14.04 | Core Enable, LLC |
| 2018-07-16 | ¥ 5 | L_Collection |
| 2018-07-26 | $ 5.44 | John Femiani |
| 2018-07-31 | ¥ 10 | w*d |
| 2018-08-04 | ¥ 50 | *建 |
| 2018-08-12 | ¥ 20 | leo陶 |
| 2018-08-15 | ¥ 300 | |
| 2018-09-12 | ¥ 50 | 鉴*o |
| 2018-09-21 | $ 200 | chvanikoff |
| 2018-10-23 | $ 2.57 | Hongjun Fu |
| 2018-10-26 | $ 2.57 | Vladimir Kravtsov |
| 2018-10-23 | $ 2.57 | Hongjun Fu |
| 2018-11-13 | ¥ 8.8 | 开源 |
| 2018-11-14 | $ 14.04 | Mateusz |
| 2018-12-04 | ¥ 30 | 兵焦 |
| 2018-12-17 | ¥ 1 | *歌 |
| 2018-12-17 | ¥ 100 | |
| 2018-12-20 | ¥ 20.19 | *尘 |
| Date     | Amount | Description       |
| ------------ | ------- | ----------------- |
| 2016-09-26 | ¥ 100 | *好 |
| 2016-09-26 | ¥ 300 | *好 |
| 2016-11-22 | ¥ 20 | *续 |
| 2017-02-23 | ¥ 40 | *拔 |
| 2017-02-14 | ¥ 100 | *洁 |
| 2017-03-18 | ¥ 20 | z*t |
| 2017-03-30 | ¥ 20 | l*n |
| 2017-04-07 | ¥ 20 | *酱 |
| 2017-06-20 | $ 2.57 | Шепелев Григорий |
| 2017-06-24 | $ 14.04 | Vowell Jason |
| 2017-06-24 | $ 2.57 | Senaud Nicolas |
| 2017-09-16 | $ 2.57 | D'Avezac Mayeul |
| 2017-09-24 | ¥ 0.99 | 1*5 |
| 2017-11-02 | ¥ 10 | *下 |
| 2017-11-02 | ¥ 10 | *下 |
| 2017-11-20 | ¥ 1.6 | *瑞 |
| 2017-11-26 | $ 14.04 | Hermans Tim |
| 2017-12-13 | $ 5.44 | Ma Fei |
| 2017-12-27 | $ 8.30 | Módolo Marcelo |
| 2017-12-28 | ¥ 20 | s*n |
| 2017-12-28   | ¥ 10.24 | bts |
| 2017-12-29 | ¥ 10 | *哥 |
| 2018-01-22 | ¥ 10 | *强 |
| 2018-01-24 | ¥ 20 | unlockingc |
| 2018-02-05 | $ 2.57 | Samuel Mitchell |
| 2018-02-13 | $ 45 | talktopete |
| 2018-02-14 | ¥ 20 | *川 |
| 2018-02-14 | ¥ 188 | *黑8 |
| 2018-02-18 | ¥ 66.6 | *谨 |
| 2018-02-22 | $ 9 | sei40kr |
| 2018-02-24 | $ 6 | kapkabnh |
| 2018-03-14 | ¥ 1 | *目 |
| 2018-03-20 | $ 10 | kovaski |
| 2018-03-26 | ¥ 0.01 | *丰 |
| 2018-03-28 | $ 2.57 | 小林 |
| 2018-03-30 | ¥ 10 | 林* |
| 2018-03-31 | ¥ 18.88 | s*n |
| 2018-04-04 | ¥ 10 | 童* |
| 2018-04-06 | ¥ 9.99 | Galaxy |
| 2018-04-20 | ¥ 5 | 可*) |
| 2018-04-29 | ¥ 5 | *中 |
| 2018-05-07 | ¥ 6.6 | *浪 |
| 2018-05-09 | ¥ 10 | S*R |
| 2018-05-16 | $ 2.57 | Daniel Beste |
| 2018-06-18 | $ 11.17 | Charalambos |
| 2018-06-20 | $ 2.57 | Jingpeng Wu |
| 2018-06-24 | ¥ 50 | 青* |
| 2018-06-25 | $ 14.04 | Core Enable, LLC |
| 2018-07-16 | ¥ 5 | L_Collection |
| 2018-07-26 | $ 5.44 | John Femiani |
| 2018-07-31 | ¥ 10 | w*d |
| 2018-08-04 | ¥ 50 | *建 |
| 2018-08-12 | ¥ 20 | leo陶 |
| 2018-08-15 | ¥ 300 | 睿 |
| 2018-09-12 | ¥ 50 | 鉴*o |
| 2018-09-21 | $ 200 | chvanikoff |
| 2018-10-23 | $ 2.57 | Hongjun Fu |
| 2018-10-26 | $ 2.57 | Vladimir Kravtsov |
| 2018-10-23 | $ 2.57 | Hongjun Fu |
| 2018-11-13 | ¥ 8.8 | 开源 |
| 2018-11-14 | $ 14.04 | Mateusz |
| 2018-12-04 | ¥ 30 | 兵焦 |
| 2018-12-17 | ¥ 1 | *歌 |
| 2018-12-17 | ¥ 100 | 涛 |
| 2018-12-20 | ¥ 20.19 | *尘 |
## Historical spending
## Historical Spending
| date     | Amount | Description                                   |
| ---------- | ------- | --------------------------------------------- |
| 2017-06-10 | - $ 5 | Host |
| 2017-01-03 | - ¥ 225 | Domain |
| Date     | Amount | Description |
| ---------- | ------- | ----------- |
| 2017-06-10 | - $ 5 | Host |
| 2017-01-03 | - ¥ 225 | Domain |