Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-04-14 07:09:11 +08:00
Code Issues Projects Releases Wiki Activity

Update documentation (#4253)

Browse Source
This commit is contained in:
Isho 2021-06-21 14:39:29 +02:00 committed by GitHub
parent cd2953624e
commit 7fc00c9c81
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
137 changed files with 851 additions and 967 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
bundle/spacevim/doc/SpaceVim.txt
View File

@ -1,17 +1,17 @@
*SpaceVim.txt*
*SpaceVim.txt*
/###### /## /##/##
/##__ ## | ## | #|__/
| ## \__/ /###### /###### /####### /######| ## | ##/##/######/####
| ###### /##__ ##|____ ##/##_____//##__ #| ## / ##| #| ##_ ##_ ##
\____ #| ## \ ## /######| ## | ########\ ## ##/| #| ## \ ## \ ##
/## \ #| ## | ##/##__ #| ## | ##_____/ \ ###/ | #| ## | ## | ##
| ######| #######| ######| ######| ####### \ #/ | #| ## | ## | ##
\______/| ##____/ \_______/\_______/\_______/ \_/ |__|__/ |__/ |__/
| ##
| ##
|__/
/###### /## /##/##
/##__ ## | ## | #|__/
| ## \__/ /###### /###### /####### /######| ## | ##/##/######/####
| ###### /##__ ##|____ ##/##_____//##__ #| ## / ##| #| ##_ ##_ ##
\____ #| ## \ ## /######| ## | ########\ ## ##/| #| ## \ ## \ ##
/## \ #| ## | ##/##__ #| ## | ##_____/ \ ###/ | #| ## | ## | ##
| ######| #######| ######| ######| ####### \ #/ | #| ## | ## | ##
\______/| ##____/ \_______/\_______/\_______/ \_/ |__|__/ |__/ |__/
| ##
| ##
|__/
wsdjeg *spacevim* *SpaceVim*
==============================================================================
@ -67,9 +67,6 @@ CONFIGURATION *SpaceVim-config*
let g:spacevim_default_indent = 2
<
*g:spacevim_expand_tab*
在输入模式下，使用空格替代 `<Tab>`
*g:spacevim_relativenumber*
启用/禁用相对行号，相对行号可以用于快速上下多行移动，默认已启用。

2
docs/404.md
View File

@ -10,6 +10,6 @@ permalink: /404.html
{% 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 the [homepage](https://spacevim.org) or check out [Blogs](https://spacevim.org/blog/)
{% endif %}

8
docs/about.md
View File

@ -5,13 +5,13 @@ description: "The goals, credits and contact information about SpaceVim."
# [Home](../) >> 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 a [layers](../layers/) 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.
## Contact us
You can also get in touch with us using the supporting email.
You can get in touch with us using the support email.
Your message will be sent to our teams, who will get back to you as soon as they can.
Please be advised that weekends and public holidays might delay response time.
@ -21,12 +21,12 @@ Email: [support@spacevim.org](mailto:support@spacevim.org)
- Mnemonic key bindings navigation
- More IDE-like features in Vim and Neovim
- Better default different languages
- Better language support by default
- Cross platform experience
## Credits & Thanks
This project exists to thank all the people who have contributed:
This project exists thanks to all the people who have contributed:
<a href="https://github.com/SpaceVim/SpaceVim/graphs/contributors"><img src="https://opencollective.com/spacevim/contributors.svg?width=890&button=false" /></a>

58
docs/api.md
View File

@ -1,6 +1,6 @@
---
title: Available APIs
description: "A list of available APIs in SpaceVim, provide compatible functions for vim and neovim."
description: "A list of available APIs in SpaceVim, provides compatible functions for vim and neovim."
---
# [Home](../) >> APIs
@ -14,8 +14,8 @@ description: "A list of available APIs in SpaceVim, provide compatible functions
## Introduction
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.
SpaceVim provides many public APIs that you can use in your plugins.
The following example shows how to load and use an API.
```vim
" use SpaceVim#api#import() to load the API
@ -38,31 +38,31 @@ echom s:file.pathSeparator
Here is the list of all available APIs, and welcome to contribute to SpaceVim.
| Name | Description |
| ------------------------------------- | -------------------------------------------------------------------------------------------------- |
| [cmdlinemenu](cmdlinemenu/) | cmdlinemenu API provides interface for making choices in a command line. |
| [data#base64](data/base64/) | data#base64 API provides base64 encode and decode functions |
| [data#dict](data/dict/) | data#dict API provides some basic functions and values for dict. |
| [data#list](data/list/) | data#list API provides some basic functions and values for list. |
| [data#number](data/number/) | data#number API provides some basic functions to generate number. |
| [data#string](data/string/) | data#string API provides some basic functions and values for string. |
| [data#toml](data/toml/) | data#toml API provides some basic functions and values for toml. |
| [file](file/) | file API provides some basic functions and values for current os. |
| [job](job/) | job API provides some basic functions for running a job |
| [logger](logger/) | logger API provides some basic functions for log message when create plugins |
| [messletters](messletters/) | messletters API provides some basic functions for generating messletters |
| [password](password/) | password API provides some basic functions for generating password |
| [system](system/) | system API provides some basic functions and values for current os. |
| [transient-state](transient-state/) | transient state API provides some basic functions and values for current os. |
| [unicode#spinners](unicode/spinners/) | unicode#spinners API provides some basic functions for starting spinners timer |
| [vim#buffer](vim/buffer/) | vim#buffer API provides some basic functions for setting and getting config of vim buffer. |
| [vim#command](vim/command/) | vim#command API provides some basic functions and values for creatting vim custom command. |
| [vim#highlight](vim/highlight/) | vim#highlight API provides some basic functions and values for getting and setting highlight info. |
| [vim#signatures](vim/signatures/) | vim#signatures API provides some basic functions for showing signatures info. |
| [vim#window](vim/window/) | vim#window API provides some basic functions for setting and getting config of vim window. |
| [vim](vim/) | vim API provides general vim functions. |
| [web#html](web/html/) | web#html API provides some basic functions and values for parser html file. |
| [web#http](web/http/) | web#http API provides some basic functions and values for http request |
| [web#xml](web/xml/) | web#xml API provides some basic functions and values for parser xml file. |
| Name | Description |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| [cmdlinemenu](cmdlinemenu/) | cmdlinemenu API provides an interface for making choices in a command line. |
| [data#base64](data/base64/) | data#base64 API provides base64 encoding and decoding functions |
| [data#dict](data/dict/) | data#dict API provides some basic functions and values for dict. |
| [data#list](data/list/) | data#list API provides some basic functions and values for list. |
| [data#number](data/number/) | data#number API provides some basic functions for number generation. |
| [data#string](data/string/) | data#string API provides some basic functions and values for string. |
| [data#toml](data/toml/) | data#toml API provides some basic functions and values for toml. |
| [file](file/) | file API provides some basic functions and values for interacting with the OS. |
| [job](job/) | job API provides some basic functions for running a jobs |
| [logger](logger/) | logger API provides some basic functions for logging messages when creating plugins |
| [messletters](messletters/) | messletters API provides some basic functions for generating messletters |
| [password](password/) | password API provides some basic functions for generating passwords |
| [system](system/) | system API provides some basic functions and values for interacting with the OS. |
| [transient-state](transient-state/) | transient state API provides some basic functions and values for interacting with the OS. |
| [unicode#spinners](unicode/spinners/) | unicode#spinners API provides some basic functions for starting spinners timer |
| [vim#buffer](vim/buffer/) | vim#buffer API provides some basic functions for setting and getting the configurations of vim buffers. |
| [vim#command](vim/command/) | vim#command API provides some basic functions and values for creatting vim custom commands. |
| [vim#highlight](vim/highlight/) | vim#highlight API provides some basic functions and values for getting and setting highlighting info. |
| [vim#signatures](vim/signatures/) | vim#signatures API provides some basic functions for showing signatures info. |
| [vim#window](vim/window/) | vim#window API provides some basic functions for setting and getting the configurations of vim windows. |
| [vim](vim/) | vim API provides general vim functions. |
| [web#html](web/html/) | web#html API provides some basic functions and values for parsing HTML files. |
| [web#http](web/http/) | web#http API provides some basic functions and values for HTTP requests |
| [web#xml](web/xml/) | web#xml API provides some basic functions and values for parsing XML files. |
<!-- SpaceVim api list end -->

2
docs/blog.md
View File

@ -1,6 +1,6 @@
---
title: "Blog"
description: "A list of latest blog about the feature of SpaceVim and tutorials of using vim."
description: "A list of the latest blog posts about the features of SpaceVim and tutorials on using vim."
---
# [Home](../) >> Blog

6
docs/community.md
View File

@ -1,6 +1,6 @@
---
title: "Community"
description: "A list of public channels SpaceVim, All messages are bridged between IRC, gitter, telegram, matrix and slack"
description: "A list of SpaceVim's public channels, All messages are bridged between IRC, gitter, telegram, matrix and slack"
---
# [Home](../) >> Community
@ -42,7 +42,7 @@ To unsubscribe, send an empty message to:
spacevim+unsubscribe@googlegroups.com
```
You can also view all the mail list history via google forum:
You can also view all of the mailing list's history via google forum:
- <i class="fas fa-envelope"></i> [google groups](https://groups.google.com/forum/#!forum/spacevim)
@ -50,7 +50,7 @@ You can also view all the mail list history via google forum:
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
`SpaceVimBot` is sent by remote user, and the format of the remote
`SpaceVimBot` are sent by a remote user, and the format of the remote
messages is:
`**Nick:**` message

30
docs/development.md
View File

@ -128,7 +128,7 @@ rather than what it did. For example, use change; not changed or changes.
#### body
Not all commits are complex enough to warrant a body,
therefore it is optional and only used when a commit requires a bit of explanation and context.
therefore it is optional and only used when a commit requires a bit of explanation and context.
#### footer
@ -140,7 +140,7 @@ The footer is optional and is used to reference issue tracker IDs.
#### Title prefix of pull request
Pull request titles should contain one of these prefix:
Pull request titles should contain one of these prefixes:
- `Add:` Adding new features.
- `Change:` Change default behaviors or the existing features.
@ -207,13 +207,13 @@ 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, don’t forget to replace **YOUR NAME** and **YOUR EMAIL** neighter.
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, don’t forget to replace **YOUR NAME** and **YOUR EMAIL** too.
#### Author of a new layer
In the files header, replace the default author name (Shidong Wang) with your name.
In the file's header, replace the default author name (Shidong Wang) with your name.
The following example shows how to create a new layer names `foo`:
The following example shows how to create a new layer named `foo`:
1. Fork SpaceVim repo.
2. Add a layer file `autoload/SpaceVim/layers/foo.vim` for `foo` layer.
@ -231,7 +231,7 @@ The following example shows how to create a new layer names `foo`:
""
" @section foo, layer-foo
" @parentsection layers
" This the doc for this layer:
" This is the doc for this layer:
"
" @subsection Key Bindings
" >
@ -283,9 +283,9 @@ function! SpaceVim#layers#foo#get_options() abort
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.
4. Create the layer's documentation file `docs/layers/foo.md` for `foo` layer.
5. Open `docs/layers/index.md`, and run `:call SpaceVim#dev#layers#update()` to update the layers list.
6. Send a PR to SpaceVim.
#### Contributor to an existing layer
@ -297,16 +297,16 @@ Mappings are an important part of SpaceVim.
First if you want to have some personal mappings. This can be done in your bootstrap function.
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.
If you think it is 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.
ALWAYS document your new mappings or mapping changes inside the relevant documentation file.
It should be the layername.md and the [documentation](../documentation/).
##### Language specified key bindings
All language specified key bindings prefix `SPC l`.
All language specified key bindings have the prefix `SPC l`.
We recommend to keep same language specified key bindings for different languages:
We recommend you to use the common language specified key bindings for the same purpose as the following:
| Key Binding | Description |
| ----------- | ------------------------------------------------ |
@ -320,7 +320,7 @@ We recommend to keep same language specified key bindings for different language
| `SPC l s l` | send line and keep code buffer focused |
| `SPC l s s` | send selection text and keep code buffer focused |
All above key bindings are just recommended as default, but they also base on the language layer itself.
All above key bindings are just recommended as default, but they are also based on the language layer itself.
#### Contributing a banner
@ -332,7 +332,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 provides a lot of public [APIs](../api/), you can create plugins based on these APIs. Also you can add a badge to the README.md of your plugin.
![](https://img.shields.io/badge/build%20with-SpaceVim-ff69b4.svg)

662
docs/documentation.md
View File

File diff suppressed because it is too large Load Diff

2
docs/faq.md
View File

@ -1,6 +1,6 @@
---
title: "FAQ"
description: "A list of questions and answers relating to SpaceVim, especially those most asked in the SpaceVim community"
description: "A list of questions and answers related to SpaceVim, especially those most asked in the SpaceVim community"
---
# [Home](../) >> FAQ

183
docs/layers.md
View File

@ -1,6 +1,6 @@
---
title: Available layers
description: "A guide for managing SpaceVim with layers, tell you how to enable and disable a layer, also list all available layers in SpaceVim"
description: "A guide for managing SpaceVim with layers, How to enable and disable a layer, and list all available layers in SpaceVim"
---
# [Home](../) >> Layers
@ -16,14 +16,15 @@ 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 collecting related packages together to provide features.
SpaceVim is a community-driven Vim distribution that seeks to provides a layers feature.
Layers help collecting related packages together to provides 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.
### Enable layers
By default SpaceVim enable these layers:
By default SpaceVim enables these layers:
- `autocomplete`
- `checkers`
@ -35,8 +36,8 @@ By default SpaceVim enable these layers:
- `core#statusline`
- `core#tabline`
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`.
To enable a specific layer you need to edit SpaceVim's custom configuration files.
The key binding for opening the configuration files.s `SPC f v d`.
The following example shows how to load `shell` layer with some specified options:
@ -65,136 +66,136 @@ Some layers are enabled by default. The following example shows how to disable `
| 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 |
| [VersionControl](VersionControl/) | This layer provides general version control features 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, and expand snippets before cursor automatically |
| [chat](chat/) | SpaceVim chatting layer provides chatting with qq and weixin in vim. |
| [checkers](checkers/) | Automatic syntax checking within SpaceVim, displays errors on the sign column and statusline. |
| [chinese](chinese/) | Layer for chinese users, includes chinese docs and runtime messages |
| [colorscheme](colorscheme/) | colorscheme provides a list of colorschemes for SpaceVim, default colorscheme is gruvbox with dark theme. |
| [core#banner](core/banner/) | This layer provides many default banners on the welcome page. |
| [core#statusline](core/statusline/) | This layer provides the 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 |
| [cscope](cscope/) | cscope layer provides a smart cscope and pycscope helpers for SpaceVim, help users win at cscope |
| [ctrlp](ctrlp/) | This layer provides a heavily customized ctrlp centric work-flow |
| [ctrlspace](ctrlspace/) | This layer provides a customized CtrlSpace centric workflow |
| [debug](debug/) | This layer provide debug workflow support in SpaceVim |
| [debug](debug/) | This layer provides 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 objects. |
| [denite](denite/) | This layer provides a heavily customized Denite centric work-flow |
| [edit](edit/) | Improve code editing exprience in SpaceVim, provides more text objects. |
| [floobits](floobits/) | This layer adds support for the peer programming tool floobits to SpaceVim. |
| [foldsearch](foldsearch/) | This layer provides functions that fold away lines that don't match a specific search pattern. |
| [format](format/) | Code formatting layer for SpaceVim, includes a variety of formatters for many filetypes |
| [fzf](fzf/) | This layers provide a heavily customized fzf centric work-flow |
| [git](git/) | This layers adds extensive support for git |
| [format](format/) | Code formatting layer for SpaceVim, includes a variety of formatters for many files.pes |
| [fzf](fzf/) | This layers provides a heavily customized fzf centric work-flow |
| [git](git/) | This layer adds extensive support for git |
| [github](github/) | This layer provides GitHub integration for SpaceVim |
| [gtags](gtags/) | This layer provides gtags manager for project |
| [japanese](japanese/) | Layer for japanese users, include japanese docs and runtime messages |
| [japanese](japanese/) | Layer for japanese users, includes japanese docs and runtime messages |
| [lang#WebAssembly](lang/WebAssembly/) | This layer adds WebAssembly support to SpaceVim |
| [lang#actionscript](lang/actionscript/) | This layer is for actionscript syntax highlighting |
| [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#aspectj](lang/aspectj/) | AsepctJ language support, include syntax highlighting. |
| [lang#asciidoc](lang/asciidoc/) | Edit AsciiDoc within vim, autopreview AsciiDoc in the default browser, with this layer you can also format AsciiDoc files. |
| [lang#aspectj](lang/aspectj/) | AspectJ language support, include syntax highlighting. |
| [lang#assembly](lang/assembly/) | This layer adds Assembly language support to SpaceVim, including syntax highlighting. |
| [lang#autohotkey](lang/autohotkey/) | This layer adds AutohotKey language support to SpaceVim. |
| [lang#batch](lang/batch/) | This layer is for DOS batch file development, provide syntax highlighting, code runner and repl support for batch file. |
| [lang#c](lang/c/) | C/C++/Object-C language support for SpaceVim, include code completion, jump to definition, quick runner. |
| [lang#chapel](lang/chapel/) | This layer is for chapel development, provide syntax checking, code runner and repl support for chapel file. |
| [lang#clojure](lang/clojure/) | This layer is for Clojure development, provide autocompletion, syntax checking, code format for Clojure file. |
| [lang#coffeescript](lang/coffeescript/) | This layer is for CoffeeScript development, provide autocompletion, syntax checking, code format for CoffeeScript file. |
| [lang#crystal](lang/crystal/) | This layer is for crystal development, provide syntax checking, code runner and repl support for crystal file. |
| [lang#csharp](lang/csharp/) | csharp language layer, including syntax highlighting, asynchronously code runner. |
| [lang#d](lang/d/) | This layer is for d development, provide syntax checking, code runner support for d file. |
| [lang#dart](lang/dart/) | This layer is for Dart development, provide autocompletion, syntax checking, code format for Dart file. |
| [lang#dockerfile](lang/dockerfile/) | DockerFile language support, includding syntax highlighting and code formatting. |
| [lang#e](lang/e/) | This layer is for e development, provide syntax checking, code runner and repl support for e file. |
| [lang#eiffel](lang/eiffel/) | This layer is for eiffel development, provides syntax highlighting, indent for eiffel file. |
| [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#fortran](lang/fortran/) | This layer is for fortran development, provide syntax checking, code runner for fortran file. |
| [lang#foxpro](lang/foxpro/) | This layer is for Visual FoxPro development, provide syntax highlighting for foxpro file. |
| [lang#batch](lang/batch/) | This layer is for DOS batch files.evelopment, provides syntax highlighting, code runner and repl support for batch files. |
| [lang#c](lang/c/) | C/C++/Object-C language support for SpaceVim, including code completion, jump to definition, and quick runner. |
| [lang#chapel](lang/chapel/) | This layer is for chapel development, provides syntax checking, code runner and repl support for chapel files. |
| [lang#clojure](lang/clojure/) | This layer is for Clojure development, provides autocompletion, syntax checking, and code formatting for Clojure files. |
| [lang#coffeescript](lang/coffeescript/) | This layer is for CoffeeScript development, provides autocompletion, syntax checking, code formatting for CoffeeScript files. |
| [lang#crystal](lang/crystal/) | This layer is for crystal development, provides syntax checking, code runner and repl support for crystal files. |
| [lang#csharp](lang/csharp/) | csharp language layer, including syntax highlighting, and asynchronous code runner. |
| [lang#d](lang/d/) | This layer is for d development, provides syntax checking, and code runner support for d files. |
| [lang#dart](lang/dart/) | This layer is for Dart development, provides autocompletion, syntax checking, and code formatting for Dart files. |
| [lang#dockerfiles.lang/dockerfile/) | DockerFile language support, including syntax highlighting and code formatting. |
| [lang#e](lang/e/) | This layer is for e development, provides syntax checking, code runner and repl support for e files. |
| [lang#eiffel](lang/eiffel/) | This layer is for eiffel development, provides syntax highlighting, and auto-indent for eiffel files. |
| [lang#elixir](lang/elixir/) | This layer is for Elixir development, provides autocompletion, syntax checking, and code formatting for Elixir files. |
| [lang#elm](lang/elm/) | This layer is for Elm development, provides autocompletion, syntax checking, code formatting for Elm files. |
| [lang#erlang](lang/erlang/) | This layer is for Erlang development, provides autocompletion, syntax checking, and code formatting for Erlang files. |
| [lang#extra](lang/extra/) | This layer adds support for extra languages to SpaceVim |
| [lang#fortran](lang/fortran/) | This layer is for fortran development, provides syntax checking, and code runner for fortran files. |
| [lang#foxpro](lang/foxpro/) | This layer is for Visual FoxPro development, provides syntax highlighting for foxpro files. |
| [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#goby](lang/goby/) | This layer is for goby development, provide syntax checking, code runner and repl support for goby file. |
| [lang#gosu](lang/gosu/) | This layer is for gosu development, provide syntax checking, code runner and repl support for gosu file. |
| [lang#graphql](lang/graphql/) | This layer adds GraphQL file support to SpaceVim |
| [lang#groovy](lang/groovy/) | This layer is for Groovy development, provide syntax checking, code runner and repl support for groovy file. |
| [lang#hack](lang/hack/) | This layer is for hack development, provide syntax checking, code runner and repl support for hack file. |
| [lang#goby](lang/goby/) | This layer is for goby development, provides syntax checking, code runner and repl support for goby files. |
| [lang#gosu](lang/gosu/) | This layer is for gosu development, provides syntax checking, code runner and repl support for gosu files. |
| [lang#graphql](lang/graphql/) | This layer adds GraphQL files.upport to SpaceVim |
| [lang#groovy](lang/groovy/) | This layer is for Groovy development, provides syntax checking, code runner and repl support for groovy files. |
| [lang#hack](lang/hack/) | This layer is for hack development, provides syntax checking, code runner and repl support for hack files. |
| [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#hy](lang/hy/) | This layer is for hy development, provide syntax checking, code runner and repl support for hy file. |
| [lang#idris](lang/idris/) | This layer is for idris development, provide syntax checking, code runner and repl support for idris file. |
| [lang#io](lang/io/) | This layer is for io development, provide code runner and repl support for io file. |
| [lang#hy](lang/hy/) | This layer is for hy development, provides syntax checking, code runner and repl support for hy files. |
| [lang#idris](lang/idris/) | This layer is for idris development, provides syntax checking, code runner and repl support for idris files. |
| [lang#io](lang/io/) | This layer is for io development, provides code runner and repl support for io files. |
| [lang#ipynb](lang/ipynb/) | This layer adds Jupyter Notebook support to SpaceVim |
| [lang#j](lang/j/) | This layer is for j development, provide syntax checking and repl support for j file. |
| [lang#janet](lang/janet/) | This layer is for janet development, provide code runner and repl support for janet file. |
| [lang#j](lang/j/) | This layer is for j development, provides syntax checking and repl support for j files. |
| [lang#janet](lang/janet/) | This layer is for janet development, provides code runner and repl support for janet files. |
| [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 provides JavaScript development support for SpaceVim, including code completion, syntax highlighting and syntax checking |
| [lang#julia](lang/julia/) | This layer is for Julia development, provide autocompletion, syntax checking and code formatting |
| [lang#julia](lang/julia/) | This layer is for Julia development, provides autocompletion, syntax checking and code formatting |
| [lang#kotlin](lang/kotlin/) | This layer adds Kotlin language support to SpaceVim, including syntax highlighting, code runner and REPL support. |
| [lang#lasso](lang/lasso/) | Lasso language support, include syntax highlighting. |
| [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 Common Lisp development, provide autocompletion, syntax checking, code format for Common Lisp file. |
| [lang#livescript](lang/livescript/) | This layer is for livescript development, provide syntax checking, code runner and repl support for livescript 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#lisp](lang/lisp/) | This layer is for Common Lisp development, provides autocompletion, syntax checking, code format for Common Lisp files. |
| [lang#livescript](lang/livescript/) | This layer is for livescript development, provides syntax checking, code runner and repl support for livescript files. |
| [lang#lua](lang/lua/) | This layer is for Lua development, provides autocompletion, syntax checking, code format for Lua files. |
| [lang#markdown](lang/markdown/) | Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown files. |
| [lang#matlab](lang/matlab/) | This layer adds matlab language support to SpaceVim, including syntax highlighting. |
| [lang#moonscript](lang/moonscript/) | This layer is for moonscript development, provide syntax checking, code runner and repl support for moonscript file. |
| [lang#moonscript](lang/moonscript/) | This layer is for moonscript development, provides syntax checking, code runner and repl support for moonscript files. |
| [lang#nim](lang/nim/) | This layer adds Nim language support to SpaceVim |
| [lang#nix](lang/nix/) | This layer adds Nix language support to SpaceVim. |
| [lang#ocaml](lang/ocaml/) | This layer is for OCaml development, provide autocompletion, syntax checking, code format for OCaml file. |
| [lang#pact](lang/pact/) | This layer is for pact development, provide syntax checking, code runner and repl support for pact file. |
| [lang#pascal](lang/pascal/) | This layer is for pascal development, provides syntax highlighting, code runner for pascal file. |
| [lang#perl](lang/perl/) | This layer is for Perl development, provide autocompletion, syntax checking, code format for Perl file. |
| [lang#ocaml](lang/ocaml/) | This layer is for OCaml development, provides autocompletion, syntax checking, code format for OCaml files. |
| [lang#pact](lang/pact/) | This layer is for pact development, provides syntax checking, code runner and repl support for pact files. |
| [lang#pascal](lang/pascal/) | This layer is for pascal development, provides syntax highlighting, code runner for pascal files. |
| [lang#perl](lang/perl/) | This layer is for Perl development, provides autocompletion, syntax checking, code format for Perl files. |
| [lang#php](lang/php/) | PHP language support, including code completion, syntax lint and code runner |
| [lang#plantuml](lang/plantuml/) | This layer is for PlantUML development, syntax highlighting for PlantUML file. |
| [lang#pony](lang/pony/) | This layer is for pony development, provide syntax checking, code runner and repl support for pony file. |
| [lang#povray](lang/povray/) | This layer is for povray development, provide syntax highlighting, viewing images. |
| [lang#powershell](lang/powershell/) | This layer is for powershell development, provide syntax checking, code runner and repl support for powershell file. |
| [lang#plantuml](lang/plantuml/) | This layer is for PlantUML development, syntax highlighting for PlantUML files. |
| [lang#pony](lang/pony/) | This layer is for pony development, provides syntax checking, code runner and repl support for pony files. |
| [lang#povray](lang/povray/) | This layer is for povray development, provides syntax highlighting, viewing images. |
| [lang#powershell](lang/powershell/) | This layer is for powershell development, provides syntax checking, code runner and repl support for powershell files. |
| [lang#processing](lang/processing/) | This layer is for working on Processing sketches. It provides syntax checking and an app runner |
| [lang#prolog](lang/prolog/) | This layer is for Prolog development, provide syntax checking, code runner and repl support for prolog file. |
| [lang#prolog](lang/prolog/) | This layer is for Prolog development, provides syntax checking, code runner and repl support for prolog files. |
| [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#r](lang/r/) | This layer is for R development, provide autocompletion, syntax checking and code format. |
| [lang#purescript](lang/purescript/) | This layer is for PureScript development, provides autocompletion, syntax checking, code format for PureScript files. |
| [lang#python](lang/python/) | This layer is for Python development, provides autocompletion, syntax checking, code format for Python files. |
| [lang#r](lang/r/) | This layer is for R development, provides autocompletion, syntax checking and code format. |
| [lang#racket](lang/racket/) | This layer adds racket language support to SpaceVim, including syntax highlighting, code runner and REPL support. |
| [lang#reason](lang/reason/) | This layer is for reason development, provide syntax checking, code runner and repl support for reason file. |
| [lang#red](lang/red/) | This layer is for Red development, provide autocompletion, syntax checking and code format. |
| [lang#rescript](lang/rescript/) | This layer is for ReScript development, provide syntax checking, code runner and repl support for ReScript file. |
| [lang#ring](lang/ring/) | This layer is for ring development, provide syntax checking, code runner and repl support for ring file. |
| [lang#reason](lang/reason/) | This layer is for reason development, provides syntax checking, code runner and repl support for reason files. |
| [lang#red](lang/red/) | This layer is for Red development, provides autocompletion, syntax checking and code format. |
| [lang#rescript](lang/rescript/) | This layer is for ReScript development, provides syntax checking, code runner and repl support for ReScript files. |
| [lang#ring](lang/ring/) | This layer is for ring development, provides syntax checking, code runner and repl support for ring files. |
| [lang#rst](lang/rst/) | Take Notes in reStructuredText, autopreview in the default browser. |
| [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#ruby](lang/ruby/) | This layer is for Ruby development, provides autocompletion, syntax checking, code format for Ruby files. |
| [lang#rust](lang/rust/) | This layer is for Rust development, provides autocompletion, syntax checking, code format for Rust files. |
| [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#slim](lang/slim/) | This layer is for slim development, includes syntax highlighting for slim file. |
| [lang#sml](lang/sml/) | This layer is for Standard ML development, provide syntax highlighting and repl support for sml file. |
| [lang#slim](lang/slim/) | This layer is for slim development, includes syntax highlighting for slim files. |
| [lang#sml](lang/sml/) | This layer is for Standard ML development, provides syntax highlighting and repl support for sml files. |
| [lang#swift](lang/swift/) | swift language support for SpaceVim, includes code completion, syntax highlighting |
| [lang#tcl](lang/tcl/) | This layer is for Tcl development, provide syntax checking, code runner and repl support for tcl file. |
| [lang#toml](lang/toml/) | This layer is for toml development, provide syntax checking, indent etc. |
| [lang#tcl](lang/tcl/) | This layer is for Tcl development, provides syntax checking, code runner and repl support for tcl files. |
| [lang#toml](lang/toml/) | This layer is for toml development, provides syntax checking, indent etc. |
| [lang#typescript](lang/typescript/) | This layer is for TypeScript development, includding code completion, Syntax lint, and doc generation. |
| [lang#v](lang/v/) | This layer is for v development, provide syntax checking, code runner and repl support for v file. |
| [lang#vbnet](lang/vbnet/) | This layer is for Visual Basic .NET development, provide code runner vb file. |
| [lang#v](lang/v/) | This layer is for v development, provides syntax checking, code runner and repl support for v files. |
| [lang#vbnet](lang/vbnet/) | This layer is for Visual Basic .NET development, provides code runner vb files. |
| [lang#vim](lang/vim/) | This layer is for writing Vimscript, including code completion, syntax checking and buffer formatting |
| [lang#vue](lang/vue/) | This layer adds Vue language support to SpaceVim |
| [lang#wolfram](lang/wolfram/) | This layer is for wolfram development, provide syntax checking, code runner and repl support for wolfram file. |
| [lang#xml](lang/xml/) | This layer is for xml development, provide syntax checking, indent etc. |
| [lang#zig](lang/zig/) | This layer is for zig development, provide code runner support for zig file. |
| [lang#wolfram](lang/wolfram/) | This layer is for wolfram development, provides syntax checking, code runner and repl support for wolfram files. |
| [lang#xml](lang/xml/) | This layer is for xml development, provides syntax checking, indent etc. |
| [lang#zig](lang/zig/) | This layer is for zig development, provides code runner support for zig files. |
| [language-server-protocol](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 |
| [leaderf](leaderf/) | This layers provides a heavily customized LeaderF centric work-flow |
| [shell](shell/) | This layer provides shell support in SpaceVim |
| [sudo](sudo/) | sudo layer provides ability to read and write files.levated privileges in SpaceVim |
| [test](test/) | 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#mpv](tools/mpv/) | This layer provides mpv integration for SpaceVim |
| [tools#zeal](tools/zeal/) | This layer provides Zeal 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 |
| [unite](unite/) | This layers provide a heavily customized Unite centric work-flow |
| [ui](ui/) | Awesome UI layer for SpaceVim, provides IDE-like UI for neovim and vim in both TUI and GUI |
| [unite](unite/) | This layers provides a heavily customized Unite centric work-flow |
<!-- SpaceVim layer list end -->

7
docs/layers/VersionControl.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim VersionControl layer"
description: "This layers provides general version control feature for vim. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc…"
description: "This layer provides general version control features for SpaceVim. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc"
---
# [Available Layers](../) >> VersionControl
@ -17,7 +17,7 @@ description: "This layers provides general version control feature for vim. It s
## Description
This layer provides general function for version control. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc…
This layer provides general functions for version control. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc.
## Features
@ -36,8 +36,7 @@ To use this configuration layer, update custom configuration file with:
## Layer options
`enable-gtm-status`: Enable diplaying time spent within SpaceVim's statusline. This feature need [gtm](https://github.com/git-time-metric/gtm) command to be installed.
`enable-gtm-status`: Enable displaying time spent within SpaceVim's statusline. This feature needs [gtm](https://github.com/git-time-metric/gtm) command to be installed.
## Key bindings

25
docs/layers/autocomplete.md
View File

@ -23,7 +23,7 @@ description: "Autocomplete code within SpaceVim, fuzzy find the candidates from
## Description
This layer provides auto-completion to SpaceVim.
This layer provides auto-completion in SpaceVim.
The following completion engines are supported:
@ -39,7 +39,7 @@ Snippets are supported via [neosnippet](https://github.com/Shougo/neosnippet.vim
## Install
To use this configuration layer, add following snippet to your custom configuration file.
To use this configuration layer, add the following snippet to your custom configuration file:
```toml
[[layers]]
@ -50,9 +50,8 @@ To use this configuration layer, add following snippet to your custom configurat
### Completion engine
By default, SpaceVim will choose the completion engine automatically base on your vim version.
But you can choose the completion engine to be used
with the following variable:
By default, SpaceVim will choose the completion engine automatically based on your vim version.
But you can choose the completion engine to be used with the following variable:
- `autocomplete_method`: the possible values are:
- `ycm`: for YouCompleteMe
@ -114,7 +113,7 @@ By default, the parens will be completed automatically, to disabled this feature
You can customize the user experience of autocompletion with the following layer variables:
1. `auto_completion_return_key_behavior` set the action to perform
when the `Return`/`Enter` key is pressed, the possible values are:
when the `Return`/`Enter` key is pressed. the possible values are:
- `complete` completes with the current selection
- `smart` completes with current selection and expand snippet or argvs
- `nil`
@ -165,13 +164,13 @@ To disable this feature, set the variable `auto_completion_enable_snippets_in_po
### Completion
| Key bindings | Description |
| ------------ | --------------------------------------------- |
| `Ctrl-n` | select next candidate |
| `Ctrl-p` | select previous candidate |
| `<Tab>` | base on `auto_completion_tab_key_behavior` |
| `Shift-Tab` | select previous candidate |
| `<Return>` | base on `auto_completion_return_key_behavior` |
| Key bindings | Description |
| ------------ | -----------------------------------------------|
| `Ctrl-n` | select next candidate |
| `Ctrl-p` | select previous candidate |
| `<Tab>` | based on `auto_completion_tab_key_behavior` |
| `Shift-Tab` | select previous candidate |
| `<Return>` | based on `auto_completion_return_key_behavior` |
### Neosnippet

10
docs/layers/chat.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim chat layer"
description: "SpaceVim chatting layer provide chatting with qq and weixin in vim."
description: "SpaceVim chatting layer provides chatting with qq and weixin in vim."
---
# [Available Layers](../) >> chat
@ -16,11 +16,11 @@ description: "SpaceVim chatting layer provide chatting with qq and weixin in vim
## Description
SpaceVim chatting layer provide chatting feature in vim.
SpaceVim chatting layer provides chatting feature in vim.
## Install
To use this configuration layer, add following snippet to your custom configuration file.
To use this configuration layer, add the following snippet to your custom configuration file.
```toml
[[layers]]
@ -34,7 +34,7 @@ To use this configuration layer, add following snippet to your custom configurat
within chatting buffer:
`Alt + Left/Right` : switch between buffer.
`Alt + 1-9` : jump to specified channel.
`Alt + Left/Right` : switch between buffers.
`Alt + 1-9` : jump to the specified channel.
for more mappings in chatting buffer, please read <kbd>:h vim-chat</kbd>.

10
docs/layers/checkers.md
View File

@ -30,12 +30,12 @@ This layer is enabled by default.
## Configuration
The checkers layer has been loaded by default, there are two kinds options for this layer:
global options and layer option.
The checkers layer is loaded by default, there are two kinds options for this layer:
global options and layer options.
**Global options:**
All of the SpaceVim global options should be put into `[options]` section.
All of the SpaceVim global options should be put into the `[options]` section.
| Name | default value | description |
| ------------- | ------------- | ------------------- |
@ -43,12 +43,12 @@ All of the SpaceVim global options should be put into `[options]` section.
The default lint engine is `neomake`, you can also use `ale` or `syntastic`.
If you want to config neomake, you can use bootstrap functions. Within bootstrap functions,
If you want to configure neomake, you can use bootstrap functions. Within bootstrap functions,
you can use vim script. For all the info about neomake configuration, please checkout `:h neomake`.
**Layer options:**
By default, the error will be display below current line, if you want to disabled this
By default, the error will be displayed below the current line, if you want to disabled this
feature, you may need to load this layer with `show_cursor_error` to `false`.
| Name | default value | description |

2
docs/layers/chinese.md
View File

@ -19,7 +19,7 @@ This layer is for Chinese users, and provide Chinese documentations and runtime
## Install
Add following snippet to your custom configuration file to use this configuration layer.
Add the following snippet to your custom configuration file to use this configuration layer.
```toml
[[layers]]

13
docs/layers/colorscheme.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim colorscheme layer"
description: "colorscheme provides a list of colorscheme for SpaceVim, default colorscheme is gruvbox with dark theme."
description: "colorscheme provides a list of colorschemes for SpaceVim, the default colorscheme is gruvbox with dark theme."
---
# [Available Layers](../) >> colorschemes
@ -54,8 +54,8 @@ Colorscheme list
| material | yes | yes | yes | yes | yes |
| SpaceVim | yes | yes | yes | yes | yes |
By default this layer only include above colorschemes. If you want to use other colorschemes which
are available on Github, use the `custom_plugins` section in configuration file. For example:
By default this layer only includes above colorschemes. If you want to use other colorschemes which
are available on Github, use the `custom_plugins` section in the configuration file. For example:
```toml
[options]
@ -69,8 +69,7 @@ are available on Github, use the `custom_plugins` section in configuration file.
```
Some colorschemes offer dark and light styles. Most of them are set by changing
Vim background color. SpaceVim support to change the background color with
`colorscheme_bg`:
Vim's background color. SpaceVim supports changing the background color with `colorscheme_bg`:
```toml
[options]
@ -78,7 +77,7 @@ Vim background color. SpaceVim support to change the background color with
colorscheme_bg = "dark"
```
Colorscheme layer support random colorscheme on startup. just load this layer with layer option `random_theme`
The colorscheme layer supports random colorschemes on startup. just load this layer with layer option `random_theme`
```toml
[[layers]]
@ -86,7 +85,7 @@ Colorscheme layer support random colorscheme on startup. just load this layer wi
random_theme = true
```
The frequency can be changed via `frequency` layer options, the available values are `daily`, `hourly`, `weekly`.
The frequency can be changed via `frequency` layer option, the available values are `daily`, `hourly`, `weekly`.
You can also use `number + unit`, for example: `1h`.
```toml

2
docs/layers/core.md
View File

@ -16,7 +16,7 @@ description: "SpaceVim core layer provides many default key bindings and feature
## Intro
This is core layer of SpaceVim, and it is loaded by default.
This is the core layer of SpaceVim, and it is loaded by default.
## Features

4
docs/layers/core/banner.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim core#banner layer"
description: "This layer provides many default banner on welcome page."
description: "This layer provides many default banners on the welcome page."
---
# [Available Layers](../) >> core#banner
@ -14,7 +14,7 @@ description: "This layer provides many default banner on welcome page."
## Description
This layer provides many default banners on welcome page.
This layer provides many default banners on the welcome page.
## Configuration

2
docs/layers/core/statusline.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim core#statusline layer"
description: "This layer provides default statusline for SpaceVim"
description: "This layer provides a default statusline for SpaceVim"
---
# [Available Layers](../) >> core#statusline

2
docs/layers/core/tabline.md
View File

@ -7,7 +7,7 @@ description: "SpaceVim core#tabline layer provides a better tabline for SpaceVim
## Intro
Different from airline, this layer provides a simple tabline for SpaceVim, which is faster and more compitable with SpaceVim's core feature.
Different from airline, this layer provides a simple tabline for SpaceVim, which is faster and more compatible with SpaceVim's core feature.
## Key bindings

14
docs/layers/ctrlspace.md
View File

@ -51,21 +51,17 @@ name = "ctrlspace"
* `home-mapping-key` (default: `<C-Space>`) - keybinding to enter CtrlSpace's
home menu, which displays the buffers list
* `autosave-workspaces` (default: `true`) - enable to autosave current
* `autosave-workspaces` (default: `true`) - enable this to autosave current
workspace on switching WS and exiting SpaceVim
* `autoload-workspaces` (default: `false`) - enable to autoload last workspace
on starting SpaceVim
* `autoload-workspaces` (default: `false`) - enable this to autoload last workspace
when starting SpaceVim
* For more granular CtrlSpace options, refer to the [plugin's GitHub
page](https://github.com/vim-ctrlspace/vim-ctrlspace).
* `enable-spacevim-styled-keys` (default: `false`) - enable to make
available [SpaceVim styled keybindings](#keybindings-spacevim-styled).
* `enable-spacevim-styled-keys` (default: `false`) - enable this to use [SpaceVim styled keybindings](#keybindings-spacevim-styled).
**Note**: when disabled, another traditional fuzzy finder layer (such
as Denite or FZF) may still be used without concerns of keybinding
conflicts.
as Denite or FZF) may still be used without concerns of keybinding conflicts.
## Keybindings: CtrlSpace Defaults

11
docs/layers/debug.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim debug layer"
description: "This layer provide debug workflow support in SpaceVim"
description: "This layer provides debug workflow support in SpaceVim"
---
# [Available Layers](../) >> debug
@ -15,12 +15,11 @@ description: "This layer provide debug workflow support in SpaceVim"
## Description
This layer provide a debug workflow for SpaceVim. All of the function is based on [vim-vebugger](https://github.com/idanarye/vim-vebugger).
This layer provides debug workflow for SpaceVim. All of the functionality is based on [vim-vebugger](https://github.com/idanarye/vim-vebugger).
## Install
To use this configuration layer, add following snippet to your custom configuration file.
To use this configuration layer, add the following snippet to your custom configuration file.
```toml
[[layers]]
@ -31,7 +30,7 @@ To use this configuration layer, add following snippet to your custom configurat
| Key Binding | Description |
| ----------- | ---------------------------------------- |
| `SPC d l` | launching debugger |
| `SPC d l` | launch the debugger |
| `SPC d c` | Continue the execution |
| `SPC d b` | Toggle a breakpoint for the current line |
| `SPC d B` | Clear all breakpoints |
@ -45,6 +44,6 @@ To use this configuration layer, add following snippet to your custom configurat
**Debug Transient State**
key bindings is too long? use `SPC d .` to open the debug transient state:
key bindings are too long? use `SPC d .` to open the debug transient state:
![Debug Transient State](https://user-images.githubusercontent.com/13142418/33996076-b03c05bc-e0a5-11e7-90fd-5f31e2703d7e.png)

4
docs/layers/default.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim default layer"
description: "SpaceVim default layer contains no plugins, but It provides some better default config for SpaceVim."
description: "SpaceVim's default layer contains no plugins, but It provides some better default config for SpaceVim."
---
# [Available Layers](../) >> default
@ -15,7 +15,7 @@ description: "SpaceVim default layer contains no plugins, but It provides some b
## Description
SpaceVim default layer contains no plugins, but it has some better default config for vim and neovim.
SpaceVim's default layer contains no plugins, but it has some better default config for vim and neovim.
## Install

4
docs/layers/denite.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim denite layer"
description: "This layers provide a heavily customized Denite centric work-flow"
description: "This layers provide's a heavily customized Denite centric workflow"
---
# [Available Layers](../) >> denite
@ -31,7 +31,7 @@ To use this configuration layer, add it to your configuration file.
## Configuration
SpaceVim use `<Leader> f` as the default key bindings prefix for denite layer.
SpaceVim uses `<Leader> f` as the default key binding prefix for the denite layer.
## Key bindings

8
docs/layers/edit.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim edit layer"
description: "Improve code edit expr in SpaceVim, provide more text objects."
description: "Improve code edit experience in SpaceVim, provides more text objects."
---
# [Available Layers](../) >> edit
@ -20,11 +20,11 @@ This layer provides many edit key bindings for SpaceVim, and also provides more
## Features
- change surround symbol via vim-surround
- repeat latest action via vim-repeat
- multiple cursor
- repeat last action via vim-repeat
- multiple cursors
- align
- set justification for paragraph
- highlight whitespaces at the end of a line
- highlight whitespace at the end of a line
- load editorconfig config, need `+python` or `+python3`
## Options

2
docs/layers/floobits.md
View File

@ -18,7 +18,7 @@ description: "This layer adds support for the peer programming tool floobits to
This layer adds support for the peer programming tool floobits to SpaceVim.
NOTE: This layer only support neovim.
NOTE: This layer only supports neovim.
## Features

6
docs/layers/foldsearch.md
View File

@ -28,13 +28,11 @@ To use this layer, add it to your configuration file.
name = "foldsearch"
```
This layer requires at least one search tools: `ag`, `rg`, `ack`, `pt` and `grep`,
Choose your favorite one.
This layer requires at least one search tool: `ag`, `rg`, `ack`, `pt` and `grep`, Choose your favorite one.
## Options
- foldsearch_highlight: a boolean option for enable/disabled highlight. Enabled by default. To disable
the highlight:
- foldsearch_highlight: a boolean option to enable/disabled highlight. Enabled by default. To disable the highlight:
```toml
[[layers]]

14
docs/layers/format.md
View File

@ -19,11 +19,11 @@ description: "Code formatting layer for SpaceVim, includes a variety of formatte
## Description
`format` layer provides code formatting feature for SpaceVim, this layer includes `neoformat`
as default code formatting plugin.
as the default code formatting plugin.
## Install
This layer is enabled by default. If you want to disable this layer, add following to your configuration file:
This layer is enabled by default. If you want to disable it, add the following to your configuration file:
```toml
[[layers]]
@ -35,7 +35,7 @@ This layer is enabled by default. If you want to disable this layer, add followi
### Layer options
- **`format_on_save`**: This layer option is to enable/disable code formatting when save current buffer,
- **`format_on_save`**: This option is to enable/disable code formatting when save current buffer,
and it is disabled by default. To enable it:
```toml
@ -44,8 +44,8 @@ This layer is enabled by default. If you want to disable this layer, add followi
format_on_save = true
```
This option can be overrided by `format_on_save` in language layer. For example, enable `format_on_save`
for all filetypes expect python.
This option can be overrided by `format_on_save` in the language layer. For example, enable `format_on_save`
for all filetypes except python.
```toml
# enable format layer
@ -60,10 +60,10 @@ This layer is enabled by default. If you want to disable this layer, add followi
### Global options
neoformat is a format framework, all of it's options can be used in bootstrap function. You can read
neoformat is a formatting framework, all of it's options can be used in bootstrap function. You can read
`:help neoformat` for more info.
here is an example for add formater for java file, and it has been included into `lang#java` layer:
here is an example to add a formater for java file, and it has been included into `lang#java` layer:
```viml
let g:neoformat_enabled_java = ['googlefmt']

2
docs/layers/fzf.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim fzf layer"
description: "This layers provide a heavily customized fzf centric work-flow"
description: "This layer provides a heavily customized fzf centric workflow"
---
# [Available Layers](../) >> fzf

6
docs/layers/git.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim git layer"
description: "This layers adds extensive support for git"
description: "This layer adds extensive support for git"
---
# [Available Layers](../) >> git
@ -16,11 +16,11 @@ description: "This layers adds extensive support for git"
## Description
This layers adds extensive support for [git](https://git-scm.com/).
This layer adds extensive support for [git](https://git-scm.com/).
## Install
To use this configuration layer, add following snippet to your custom configuration file (`SPC f v d`).
To use this configuration layer, add the following snippet to your custom configuration file (`SPC f v d`).
```toml
[[layers]]

6
docs/layers/github.md
View File

@ -37,8 +37,8 @@ To use this configuration layer, add the following snippet to your custom config
| `SPC g h f` | show current file in browser |
| `SPC g h I` | show issues in browser |
| `SPC g h p` | show PRs in browser |
| `SPC g g l` | list all gist |
| `SPC g g p` | post gist |
| `SPC g g l` | list all gists |
| `SPC g g p` | post a gist |
## Extra configuration for GitHub and Gist
@ -51,7 +51,9 @@ func! myspacevim#before() abort
let g:gista#client#default_username = 'monkeyxite'
endf
```
We recommend generating a [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) and storing it securely in an environment variable. [Refer to github dashboard](https://github.com/junegunn/vim-github-dashboard) for more information.
```shell
# in some secure file sourced in your .bashrc, .bash_profile, .zshrc, etc.
export GITHUB_TOKEN="<your 40 char token>"

8
docs/layers/gtags.md
View File

@ -44,7 +44,7 @@ this layer can be used to generate and update tags database automatically.
## Installation
To use `gtags` layer, you first have to install [GNU Global](https://www.gnu.org/software/global/download.html).
You can install global from the software repository of your OS or built from source.
You can install global from the software repository of your OS or build it from source.
**Install on Ubuntu:**
@ -81,7 +81,7 @@ sudo make install
## Configuration
gtags layer provides following options:
gtags layer provides the following options:
- `gtagslabel`: the backend of gtags command, you can use `ctags` or `pygments`. It is empty string by default.
for example, to use pygments as backend:
@ -137,8 +137,8 @@ and use that as the backend the following additional languages will have tags cr
### Pygments languages
In order to look up symbol references for any language not in the built in parser you must use the pygments backend.
When this backend is used global actually uses both ctags and pygments to find the definitions
In order to look up symbol references for any language not in the built-in parser, you must use the pygments backend.
When this backend is used, global actually uses both ctags and pygments to find the definitions
and uses of functions and variables as well as “other symbols”.
If you enabled pygments (the best choice) and use that as the backend

6
docs/layers/japanese.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim japanese layer"
description: "Layer for japanese users, include japanese docs and runtime messages"
description: "Layer for japanese users, includes japanese docs and runtime messages"
---
# [Available Layers](../) >> japanese
@ -15,11 +15,11 @@ description: "Layer for japanese users, include japanese docs and runtime messag
## Description
This layer is for japanese users, and provide japanese docs and runtime messages.
This layer is for japanese users, and provides japanese docs and runtime messages.
## Install
To use this configuration layer, add following snippet to your custom configuration file.
To use this configuration layer, add the following snippet to your custom configuration file.
```toml
[[layers]]

2
docs/layers/lang/WebAssembly.md
View File

@ -23,7 +23,7 @@ This layer adds WebAssembly language support to SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

2
docs/layers/lang/actionscript.md
View File

@ -18,7 +18,7 @@ This layer is for actionscript development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

2
docs/layers/lang/agda.md
View File

@ -25,7 +25,7 @@ This layer adds [Agda](https://github.com/agda/agda) language support to SpaceVi
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/asciidoc.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#asciidoc layer"
description: "Edit AsciiDoc within vim, autopreview AsciiDoc in the default browser, with this layer you can also format AsciiDoc file."
description: "Edit AsciiDoc within vim, autopreview AsciiDoc in the default browser, with this layer you can also format AsciiDoc files."
---
# [Available Layers](../../) >> lang#asciidoc
@ -17,11 +17,11 @@ description: "Edit AsciiDoc within vim, autopreview AsciiDoc in the default brow
## Description
This layer is for editing AsciiDoc file. Including syntax highlighting, indent and syntax lint.
This layer is for editing AsciiDoc files. Including syntax highlighting, indent and syntax lint.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/aspectj.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#asepctj layer"
description: "AsepctJ language support, include syntax highlighting."
description: "AsepctJ language support, including syntax highlighting."
---
# [Available Layers](../../) >> lang#asepctj
@ -14,11 +14,11 @@ description: "AsepctJ language support, include syntax highlighting."
## Description
This layer is for editing AsepctJ file, include syntax highlighting.
This layer is for editing AsepctJ file, including syntax highlighting.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

2
docs/layers/lang/assembly.md
View File

@ -23,7 +23,7 @@ This layer adds Assembly language support to SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

2
docs/layers/lang/autohotkey.md
View File

@ -24,7 +24,7 @@ This layer adds AutohotKey language support to SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

11
docs/layers/lang/batch.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#batch layer"
description: "This layer is for DOS batch file development, provide syntax highlighting, code runner and repl support for batch file."
description: "This layer is for DOS batch file development, provides syntax highlighting, code runner and repl support for batch files."
---
# [Available Layers](../../) >> lang#batch
@ -18,11 +18,11 @@ description: "This layer is for DOS batch file development, provide syntax highl
## Description
This layer is for DOS batch file development, which provides syntax highlighting, code runner and repl support for batch file.
This layer is for DOS batch file development, which provides syntax highlighting, code runner and repl support for batch files.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a batch file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a batch file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process
@ -50,6 +50,3 @@ Send code to inferior process commands:
| `SPC l s b` | send buffer and keep code buffer focused |
| `SPC l s l` | send line and keep code buffer focused |
| `SPC l s s` | send selection text and keep code buffer focused |

16
docs/layers/lang/c.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#c layer"
description: "C/C++/Object-C language support for SpaceVim, include code completion, jump to definition, quick runner."
description: "C/C++/Object-C language support for SpaceVim, including code completion, jump to definition, and quick runner."
---
# [Available Layers](../../) >> lang#c
@ -103,10 +103,10 @@ it is disabled, to enable it:
## Key bindings
| key bindings | Descriptions |
| ------------ | ---------------------------- |
| `SPC l d` | show documentation |
| `SPC l e` | rename symbol |
| `SPC l f` | references |
| `SPC l r` | compile and run current file |
| `g d` | defintion preview |
| key bindings | Descriptions |
| ------------ | -------------------------------- |
| `SPC l d` | show documentation |
| `SPC l e` | rename symbol |
| `SPC l f` | references |
| `SPC l r` | compile and run the current file |
| `g d` | defintion preview |

6
docs/layers/lang/chapel.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#chapel layer"
description: "This layer is for chapel development, provide syntax checking, code runner and repl support for chapel file."
description: "This layer is for chapel development. provides syntax checking, code runner and repl support for chapel files."
---
# [Available Layers](../../) >> lang#chapel
@ -21,7 +21,7 @@ This layer is for chapel development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -35,4 +35,4 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a chapel file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a chapel file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.

6
docs/layers/lang/clojure.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#clojure layer"
description: "This layer is for Clojure development, provide autocompletion, syntax checking, code format for Clojure file."
description: "This layer is for Clojure development, provides autocompletion, syntax checking, code format for Clojure files."
---
# [Available Layers](../../) >> lang#clojure
@ -31,7 +31,7 @@ This layer is for Clojure development, and it includes vim-clojure-static and vi
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -53,7 +53,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a clojure file, you can press `SPC l r` to run current file without loss focus,
To run a clojure file, you can press `SPC l r` to run the current file without losing focus,
and the result will be shown in a runner buffer.
### Inferior REPL process

7
docs/layers/lang/coffeescript.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#coffeescript layer"
description: "This layer is for CoffeeScript development, provide autocompletion, syntax checking, code format for CoffeeScript file."
description: "This layer is for CoffeeScript development, provides autocompletion, syntax checking, code format for CoffeeScript files."
---
# [Available Layers](../../) >> lang#coffeescript
@ -30,7 +30,7 @@ This layer is for CoffeeScript development, and it includes vim-coffeescript.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -41,7 +41,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a coffeescript file, you can press `SPC l r` to run current file without loss focus,
To run a coffeescript file, you can press `SPC l r` to run the current file without losing focus,
and the result will be shown in a runner buffer.
### Inferior REPL process
@ -55,4 +55,3 @@ Send code to inferior process commands:
| `SPC l s b` | send buffer and keep code buffer focused |
| `SPC l s l` | send line and keep code buffer focused |
| `SPC l s s` | send selection text and keep code buffer focused |

6
docs/layers/lang/crystal.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#crystal layer"
description: "This layer is for crystal development, provide syntax checking, code runner and repl support for crystal file."
description: "This layer is for crystal development, provides syntax checking, code runner and repl support for crystal files."
---
# [Available Layers](../../) >> lang#crystal
@ -22,7 +22,7 @@ This layer is for crystal development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -40,7 +40,7 @@ To use REPL for crystal, you need to install [icr](https://github.com/crystal-co
### Running current script
To running a crystal file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a crystal file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/csharp.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#csharp layer"
description: "csharp language layer, including syntax highlighting, asynchronously code runner."
description: "csharp language layer, including syntax highlighting, asynchronous code runner."
---
# [Available Layers](../../) >> lang#csharp
@ -19,7 +19,7 @@ This layer is for csharp development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update the custom configuration file with:
```toml
[[layers]]
@ -27,7 +27,7 @@ To use this configuration layer, update custom configuration file with:
highlight_types = 0
```
When opening a cs file at first time, it will popup a window and ask whether install the OmniSharp
When opening a cs file for the first time, it will popup a window and ask whether install the OmniSharp
server or not, enter 'Y' to confirm.
If you choose "coc" as your auto completion engine, you must run ":CocInstall coc-omnisharp"

6
docs/layers/lang/d.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#d layer"
description: "This layer is for d development, provide syntax checking, code runner support for d file."
description: "This layer is for d development, provides syntax checking and code runner support for d files."
---
# [Available Layers](../../) >> lang#d
@ -22,7 +22,7 @@ This layer is for d development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -44,7 +44,7 @@ dub fetch drepl
### Running current script
To running a d file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a d file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

10
docs/layers/lang/dart.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#dart layer"
description: "This layer is for Dart development, provide autocompletion, syntax checking, code format for Dart file."
description: "This layer is for Dart development, provides autocompletion, syntax checking and code formatting for Dart files."
---
# [Available Layers](../../) >> lang#dart
@ -39,7 +39,7 @@ This layer is for Dart development.
### Layer
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -79,11 +79,11 @@ Send code to inferior process commands:
### Running current script
To running a ruby script, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a ruby script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Code formatting
The code formatting is provided by `format` layer, and it will run `dartfmt` asynchronously.
The code formatting is provided by the `format` layer, and it will run `dartfmt` asynchronously.
| Key Bindings | Descriptions |
| ------------ | --------------------- |
@ -91,7 +91,7 @@ The code formatting is provided by `format` layer, and it will run `dartfmt` asy
### Flutter integration
When edit dart file, the following key bindings are available for running flutter commands.
When editing a dart file, the following key bindings are available for running flutter commands.
| Key bindings | Descriptions |
| ------------ | -------------------------------- |

8
docs/layers/lang/dockerfile.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#dockerfile layer"
description: "DockerFile language support, includding syntax highlighting and code formatting."
description: "Dockerfile language support, including syntax highlighting and code formatting."
---
# [Available Layers](../../) >> lang#dockerfile
@ -15,16 +15,16 @@ description: "DockerFile language support, includding syntax highlighting and co
## Description
This layer adds DockerFile language support to SpaceVim.
This layer adds Dockerfile language support to SpaceVim.
## Features
- syntax highlighting
- lsp support (require [lsp](https://spacevim.org/layers/language-server-protocol/) layer)
- lsp support (requires [lsp](https://spacevim.org/layers/language-server-protocol/) layer)
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/e.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#e layer"
description: "This layer is for e development, provide syntax checking, code runner and repl support for e file."
description: "This layer is for e development, provides syntax checking, code runner and repl support for e files."
---
# [Available Layers](../../) >> lang#e
@ -23,7 +23,7 @@ This layer is for [e](http://erights.org/index.html) development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -54,7 +54,7 @@ for example:
### Running current script
To running a e file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run an e file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

4
docs/layers/lang/eiffel.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#eiffel layer"
description: "This layer is for eiffel development, provides syntax highlighting, indent for eiffel file."
description: "This layer is for eiffel development, provides syntax highlighting and indentation for eiffel files."
---
# [Available Layers](../../) >> lang#eiffel
@ -19,7 +19,7 @@ This layer is for eiffel development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

8
docs/layers/lang/elixir.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#elixir layer"
description: "This layer is for Elixir development, provide autocompletion, syntax checking, code format for Elixir file."
description: "This layer is for Elixir development, provides autocompletion, syntax checking, code formatting for Elixir files."
---
# [Available Layers](../../) >> lang#elixir
@ -24,7 +24,7 @@ This layer is for Elixir development.
## Features
This layer include the plugin [slashmili/alchemist.vim](https://github.com/slashmili/alchemist.vim), which provides:
This layer includes the plugin [slashmili/alchemist.vim](https://github.com/slashmili/alchemist.vim), which provides:
- Completion for Modules and functions.
- Documentation lookup for Modules and functions.
@ -37,7 +37,7 @@ for Elixir, you need to load `lsp` layer for Elixir.
### Layer
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -69,4 +69,4 @@ Send code to inferior process commands:
### Running current script
To running current script, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run the current script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.

7
docs/layers/lang/elm.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#elm layer"
description: "This layer is for Elm development, provide autocompletion, syntax checking, code format for Elm file."
description: "This layer is for Elm development, provides autocompletion, syntax checking and code formatting for Elm files."
image: https://user-images.githubusercontent.com/13142418/44625046-7b2f7700-a931-11e8-807e-dba3f73c9e90.png
---
@ -26,7 +26,8 @@ This layer is for Elm development.
## Features
- Code completion
- Syntax highlighting, indent
- Syntax highlighting
- Indentation
- Running unite test
- Syntax checking
- Find symbol doc
@ -63,7 +64,7 @@ npm install -g elm-format
### Layer
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/erlang.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#elang layer"
description: "This layer is for Erlang development, provide autocompletion, syntax checking, code format for Erlang file."
description: "This layer is for Erlang development, provides autocompletion, syntax checking and code formatting for Erlang files."
---
# [Available Layers](../../) >> lang#erlang
@ -34,7 +34,7 @@ for Erlang, you need to load `lsp` layer for Erlang.
### Layer
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/extra.md
View File

@ -15,7 +15,7 @@ description: "This layer adds extra language support to SpaceVim"
## Description
This layer adds many extra language support for less common languages to SpaceVim.
This layer adds extra language support for less common languages to SpaceVim.
## Included languages
@ -32,7 +32,7 @@ This layer adds many extra language support for less common languages to SpaceVi
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/fennel.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#fennel layer"
description: "This layer is for fennel development, provide syntax checking, code runner and repl support for fennel file."
description: "This layer is for fennel development, provides syntax checking, code runner and repl support for fennel files."
---
# [Available Layers](../../) >> lang#fennel
@ -24,7 +24,7 @@ description: "This layer is for fennel development, provide syntax checking, cod
## Install
This layer is not enabled by default.
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -46,7 +46,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a fennel file, you can press `SPC l r` to run current file without loss focus,
To run a fennel file, you can press `SPC l r` to run the current file without losing focus,
and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/fortran.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#fortran layer"
description: "This layer is for fortran development, provide syntax checking, code runner for fortran file."
description: "This layer is for fortran development, provides syntax checking and code runner for fortran files."
---
# [Available Layers](../../) >> lang#fortran
@ -22,7 +22,7 @@ This layer is for fortran development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -45,7 +45,7 @@ $ gem install frepl
### Running current script
To running a fortran file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a fortran file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

4
docs/layers/lang/foxpro.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#foxpro layer"
description: "This layer is for Visual FoxPro development, provide syntax highlighting for foxpro file."
description: "This layer is for Visual FoxPro development, provides syntax highlighting for foxpro files."
---
# [Available Layers](../../) >> lang#foxpro
@ -19,7 +19,7 @@ This layer is for foxpro development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/fsharp.md
View File

@ -21,7 +21,7 @@ This layer adds FSharp language support to SpaceVim.
## Features
- syntax highlighting, indent provide by [vim-fsharp](https://github.com/wsdjeg/vim-fsharp)
- syntax highlighting, indentation provided by [vim-fsharp](https://github.com/wsdjeg/vim-fsharp)
- REPL support
## Install
@ -32,7 +32,7 @@ This layer adds FSharp language support to SpaceVim.
yaourt -S fsharp-git
```
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/go.md
View File

@ -20,7 +20,7 @@ This layer is for golang development. It also provides additional language-speci
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -72,7 +72,7 @@ go get -u github.com/jstemmer/gotags
**Code formatting:**
the default key bindings for format current buffer is `SPC b f`, and this key bindings is defined in [format layer](<>). You can also use `g=` to indent current buffer.
the default key bindings for formatting current buffer is `SPC b f`, and this key bindings is defined in [format layer](<>). You can also use `g=` to indent current buffer.
To make neoformat support go files, you should have [go-fmt](http://golang.org/cmd/gofmt/) command available, or
install [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports). `go-fmt` is delivered by golang's default installation, so make sure you have correctly setup your go environment.

6
docs/layers/lang/goby.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#goby layer"
description: "This layer is for goby development, provide syntax checking, code runner and repl support for goby file."
description: "This layer is for goby development, provides syntax checking, code runner and repl support for goby files."
---
# [Available Layers](../../) >> lang#goby
@ -22,7 +22,7 @@ This layer is for goby development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a goby file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a goby file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/gosu.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#gosu layer"
description: "This layer is for gosu development, provide syntax checking, code runner and repl support for gosu file."
description: "This layer is for gosu development, provides syntax checking, code runner and repl support for gosu files."
---
# [Available Layers](../../) >> lang#gosu
@ -21,7 +21,7 @@ This layer is for gosu development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -35,5 +35,5 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a gosu file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a gosu file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.

2
docs/layers/lang/graphql.md
View File

@ -23,7 +23,7 @@ This layer adds GraphQL file support to SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/groovy.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#groovy layer"
description: "This layer is for Groovy development, provide syntax checking, code runner and repl support for groovy file."
description: "This layer is for Groovy development, provides syntax checking, code runner and repl support for groovy files."
---
# [Available Layers](../../) >> lang#groovy
@ -22,7 +22,7 @@ This layer is for Groovy development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a Tcl script, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a Tcl script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/hack.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#hack layer"
description: "This layer is for hack development, provide syntax checking, code runner and repl support for hack file."
description: "This layer is for hack development, provides syntax checking, code runner and repl support for hack files."
---
# [Available Layers](../../) >> lang#hack
@ -22,7 +22,7 @@ This layer is for hack development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a hack file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a hack file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/haskell.md
View File

@ -26,7 +26,7 @@ This layer is for Haskell development. This layer includes following plugins:
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -47,8 +47,8 @@ After updating configuration file, restart SpaceVim and run `:SPInstall`.
### Running current script
To running a haskell file, you can press `SPC l r` to run current file
without loss focus, and the result will be shown in a runner buffer.
To run a haskell file, you can press `SPC l r` to run the current file
without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

4
docs/layers/lang/html.md
View File

@ -22,7 +22,7 @@ This layer adds support for editing HTML and CSS.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -49,7 +49,7 @@ npm install --global vscode-html-languageserver-bin
## Features
- Generate HTML and CSS coding using [neosnippet](https://github.com/Shougo/neosnippet.vim/) and [emmet-vim](https://github.com/mattn/emmet-vim)
- Generate HTML and CSS code using [neosnippet](https://github.com/Shougo/neosnippet.vim/) and [emmet-vim](https://github.com/mattn/emmet-vim)
- Tags navigation on key `%` using vim-matchup
- auto-completion
- syntax checking

6
docs/layers/lang/hy.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#hy layer"
description: "This layer is for hy development, provide syntax checking, code runner and repl support for hy file."
description: "This layer is for hy development, provides syntax checking, code runner and repl support for hy files."
---
# [Available Layers](../../) >> lang#hy
@ -24,7 +24,7 @@ description: "This layer is for hy development, provide syntax checking, code ru
## Install
This layer is not enabled by default.
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -46,7 +46,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a hy file, you can press `SPC l r` to run current file without loss focus,
To run a hy file, you can press `SPC l r` to run the current file without losing focus,
and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/idris.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#idris layer"
description: "This layer is for idris development, provide syntax checking, code runner and repl support for idris file."
description: "This layer is for idris development, provides syntax checking, code runner and repl support for idris files."
image: https://user-images.githubusercontent.com/13142418/65492491-9dece000-dee3-11e9-8eda-7d41a6c1ee79.png
---
@ -23,7 +23,7 @@ This layer is for idris development, which is based on [wsdjeg/vim-idris](https:
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -56,7 +56,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a idris file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run an idris file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/io.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#io layer"
description: "This layer is for io development, provide code runner and repl support for io file."
description: "This layer is for io development, provides code runner and repl support for io files."
---
# [Available Layers](../../) >> lang#io
@ -22,7 +22,7 @@ This layer is for io development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a io file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a io file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

2
docs/layers/lang/ipynb.md
View File

@ -34,7 +34,7 @@ NOTE: if you are using windows, you need to add this dir to your \$PATH.
`%HOME%\AppData\Roaming\Python\Python37\Scripts`
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/j.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#j layer"
description: "This layer is for j development, provide syntax checking and repl support for j file."
description: "This layer is for j development, provides syntax checking and repl support for j files."
---
# [Available Layers](../../) >> lang#j
@ -21,7 +21,7 @@ This layer is for [j language](https://www.jsoftware.com/#/) development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/janet.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#janet layer"
description: "This layer is for janet development, provide code runner and repl support for janet file."
description: "This layer is for janet development, provides code runner and repl support for janet files."
---
# [Available Layers](../../) >> lang#janet
@ -22,7 +22,7 @@ This layer is for janet development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a janet file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a janet file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

4
docs/layers/lang/java.md
View File

@ -38,7 +38,7 @@ This layer is for Java development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -137,7 +137,7 @@ You can also use `g=` to indent current buffer.
| Key bindings | Descriptions |
| ------------ | ------------------------------- |
| `SPC l r m` | run main method of current file |
| `SPC l r m` | run current method |
| `SPC l r m` | run the current method |
| `SPC l r t` | run all test methods |
### Inferior REPL process

4
docs/layers/lang/javascript.md
View File

@ -25,7 +25,7 @@ This layer is for JavaScript development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -84,7 +84,7 @@ it is disabled, to enable it:
### Code runner
To run JavaScript code in current buffer, you can press `SPC l r`. It will run without loss focus,
To run JavaScript code in current buffer, you can press `SPC l r`. It will run without losing focus,
and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/julia.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#julia layer"
description: "This layer is for Julia development, provide autocompletion, syntax checking and code formatting"
description: "This layer is for Julia development, provides autocompletion, syntax checking and code formatting"
---
# [Available Layers](../../) >> lang#julia
@ -32,7 +32,7 @@ SpaceVim also provides REPL support for Julia.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -55,4 +55,4 @@ Send code to inferior process commands:
### Running current script
To running current script, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run the current script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.

4
docs/layers/lang/kotlin.md
View File

@ -31,7 +31,7 @@ This layer adds Kotlin language support to SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -64,7 +64,7 @@ Send code to inferior process commands:
### Running current file
To running current file, you can press `SPC l r` to run current file without loss focus,
To run the current file, you can press `SPC l r` to run the current file without losing focus,
and the result will be shown in a runner buffer.
## Language Server Protocol

4
docs/layers/lang/lasso.md
View File

@ -14,11 +14,11 @@ description: "Lasso language support, include syntax highlighting."
## Description
This layer is for editing lasso file, include syntax highlighting.
This layer is for editing lasso file, including syntax highlighting.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/latex.md
View File

@ -16,7 +16,7 @@ description: "This layer provides support for writing LaTeX documents, including
## Description
This layer is for LaTex development. [vimtex](https://github.com/lervag/vimtex) is incuded in this layer.
This layer is for LaTex development. [vimtex](https://github.com/lervag/vimtex) is included in this layer.
## Features
@ -27,7 +27,7 @@ This layer is for LaTex development. [vimtex](https://github.com/lervag/vimtex)
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/lisp.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#lisp layer"
description: "This layer is for Common Lisp development, provide autocompletion, syntax checking, code format for Common Lisp file."
description: "This layer is for Common Lisp development, provides autocompletion, syntax checking, and code formatting for Common Lisp files."
---
# [Available Layers](../../) >> lang#lisp
@ -20,7 +20,7 @@ This layer is for Common Lisp development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/livescript.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#livescript layer"
description: "This layer is for livescript development, provide syntax checking, code runner and repl support for livescript file."
description: "This layer is for livescript development, provides syntax checking, code runner and repl support for livescript files."
---
# [Available Layers](../../) >> lang#livescript
@ -22,7 +22,7 @@ This layer is for livescript development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a livescript file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a livescript file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

6
docs/layers/lang/lua.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#lua layer"
description: "This layer is for Lua development, provide autocompletion, syntax checking, code format for Lua file."
description: "This layer is for Lua development, provides autocompletion, syntax checking, and code format for Lua files."
---
# [Available Layers](../../) >> lang#lua
@ -23,7 +23,7 @@ This layer is for Lua development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -48,7 +48,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a Lua script, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a Lua script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

12
docs/layers/lang/markdown.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#markdown layer"
description: "Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown file."
description: "Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown files."
---
# [Available Layers](../../) >> lang#markdown
@ -22,20 +22,20 @@ This layer is for editing markdown file.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
name = "lang#markdown"
```
The tagbar support is provided via lvht/tagbar-markdown which needs php has been installed. You can also use [mdctags](https://github.com/wsdjeg/mdctags.rs)
The tagbar support is provided via lvht/tagbar-markdown which requires php to be installed. You can also use [mdctags](https://github.com/wsdjeg/mdctags.rs)
which is written in rust.
## Formatting
SpaceVim uses remark to format Markdown file by default.
You can install remark via [npm](https://www.npmjs.com/get-npm), the commands are shown as below.
You can install remark via [npm](https://www.npmjs.com/get-npm), the commands are shown below.
```sh
npm -g install remark
@ -48,7 +48,7 @@ npm -g install wcwidth
To use [Prettier](https://github.com/prettier/prettier),
you need to change the layer option: `enabled_formater`.
You can install [Prettier](https://github.com/prettier/prettier) via [yarn](https://yarnpkg.com/lang/zh-hans/docs/install/#windows-stable) or [npm](https://www.npmjs.com/get-npm), the commands are shown as below:
You can install [Prettier](https://github.com/prettier/prettier) via [yarn](https://yarnpkg.com/lang/zh-hans/docs/install/#windows-stable) or [npm](https://www.npmjs.com/get-npm), the commands are shown below:
1. Via `yarn`
@ -82,7 +82,7 @@ Bullet marker to use for list items (`'-'`, `'*'`, or `'+'`, default: `'-'`).
**enabled_formater**
Specific the enabled formater for markdown file, default is `['remark']`. You can also append this list with other markdown formatter(s), such as `["remark", "prettier"]`.
Specify the enabled formater for markdown file, default is `['remark']`. You can also append multiple formatters to this list. e.g. `["remark", "prettier"]`.
## Tagbar

4
docs/layers/lang/matlab.md
View File

@ -24,7 +24,7 @@ This layer adds matlab language support to SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -33,5 +33,5 @@ To use this configuration layer, update custom configuration file with:
## Running current file
To running current file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run the current file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.

6
docs/layers/lang/moonscript.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#moonscript layer"
description: "This layer is for moonscript development, provide syntax checking, code runner and repl support for moonscript file."
description: "This layer is for moonscript development, provides syntax checking, code runner and repl support for moonscript files."
---
# [Available Layers](../../) >> lang#moonscript
@ -22,7 +22,7 @@ This layer is for moonscript development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a moonscript file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a moonscript file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

14
docs/layers/lang/nim.md
View File

@ -29,14 +29,14 @@ Nim is a compiled, garbage-collected systems programming language.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
name = "lang#nim"
```
Before using this layer, you need to install Nim via package manager. For example in archlinux:
Before using this layer, you need to install Nim via a package manager. For example in archlinux:
```sh
sudo pacman -S nim nimble
@ -44,11 +44,11 @@ sudo pacman -S nim nimble
## Key bindings
| Key Bindings | Descriptions |
| ------------ | ---------------------------- |
| `SPC l r` | compile and run current file |
| `SPC l e` | rename symbol in file |
| `SPC l E` | rename symbol in project |
| Key Bindings | Descriptions |
| ------------ | -------------------------------- |
| `SPC l r` | compile and run the current file |
| `SPC l e` | rename symbol in file |
| `SPC l E` | rename symbol in project |
### Inferior REPL process

2
docs/layers/lang/nix.md
View File

@ -24,7 +24,7 @@ This layer adds [Nix](https://nixos.org/nix/manual/) language support to SpaceVi
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

4
docs/layers/lang/ocaml.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#ocaml layer"
description: "This layer is for OCaml development, provide autocompletion, syntax checking, code format for OCaml file."
description: "This layer is for OCaml development, provides autocompletion, syntax checking, and code formatting for OCaml files."
---
# [Available Layers](../../) >> lang#ocaml
@ -22,7 +22,7 @@ When using in a multi-file project, be sure to include a [.merlin](https://githu
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/pact.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#pact layer"
description: "This layer is for pact development, provide syntax checking, code runner and repl support for pact file."
description: "This layer is for pact development, provides syntax checking, code runner and repl support for pact files."
---
# [Available Layers](../../) >> lang#pact
@ -22,7 +22,7 @@ This layer is for pact development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a pact file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a pact file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

4
docs/layers/lang/pascal.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#pascal layer"
description: "This layer is for pascal development, provides syntax highlighting, code runner for pascal file."
description: "This layer is for pascal development, provides syntax highlighting, and code runner for pascal files."
---
# [Available Layers](../../) >> lang#pascal
@ -21,7 +21,7 @@ the compiler before using this layer.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/perl.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#perl layer"
description: "This layer is for Perl development, provide autocompletion, syntax checking, code format for Perl file."
description: "This layer is for Perl development, provides autocompletion, syntax checking, and code formatting for Perl files."
---
# [Available Layers](../../) >> lang#perl
@ -31,7 +31,7 @@ SpaceVim also provides REPL/Debug support for Perl.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -70,4 +70,4 @@ Send code to inferior process commands:
### Running current script
To running current script, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run the current script, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.

2
docs/layers/lang/php.md
View File

@ -55,7 +55,7 @@ snippet into SpaceVim configuration file:
### Running current script
To running a php script, you can press `SPC l r` to run current file without loss focus,
To run a php script, you can press `SPC l r` to run the current file without losing focus,
and the result will be shown in a runner buffer.
### Inferior REPL process

9
docs/layers/lang/plantuml.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#plantuml layer"
description: "This layer is for PlantUML development, syntax highlighting for PlantUML file."
description: "This layer is for PlantUML development, provides syntax highlighting for PlantUML files."
---
# [Available Layers](../../) >> lang#plantuml
@ -29,7 +29,7 @@ This layer is for PlantUML development.
### Layer
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -38,9 +38,8 @@ To use this configuration layer, update custom configuration file with:
## Configuration
When you want to see picture which plantuml draw, you need to set
plantuml_jar_path. You should find or install plantuml.jar in
your system.
When you want to see the picture which plantuml drew, you need to set
plantuml_jar_path. You also need to install [plantuml.jar](https://plantuml.com/download) on your system.
Then you give the path to `plantuml_jar_path`. see below.
This is just example.

6
docs/layers/lang/pony.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#pony layer"
description: "This layer is for pony development, provide syntax checking, code runner and repl support for pony file."
description: "This layer is for pony development, provides syntax checking, code runner and repl support for pony files."
---
# [Available Layers](../../) >> lang#pony
@ -21,7 +21,7 @@ This layer is for pony development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -35,5 +35,5 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a pony file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a pony file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.

4
docs/layers/lang/povray.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#povray layer"
description: "This layer is for povray development, provide syntax highlighting, viewing images."
description: "This layer is for povray development, provides syntax highlighting, and viewing images."
---
# [Available Layers](../../) >> lang#povray
@ -18,7 +18,7 @@ This layer is for writing [POV-Ray](https://www.povray.org/) code, including syn
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

6
docs/layers/lang/powershell.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#powershell layer"
description: "This layer is for powershell development, provide syntax checking, code runner and repl support for powershell file."
description: "This layer is for powershell development, provides syntax checking, code runner and repl support for powershell files."
---
# [Available Layers](../../) >> lang#powershell
@ -22,7 +22,7 @@ This layer is for powershell development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -37,7 +37,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a powershell file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a powershell file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

4
docs/layers/lang/processing.md
View File

@ -34,7 +34,7 @@ Once you have the IDE, you can select Tools -> install "processing-java".
### Layer
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -50,5 +50,5 @@ To use this configuration layer, update custom configuration file with:
### Code runner
You can build and run your sketch with `SPC l r`.
The sketch to run is decided based on the directory of you current buffer.
The sketch to run is decided based on the directory of your current buffer.
Note that the sketch is run asynchonously, so you are free to continue editing while it is running.

6
docs/layers/lang/prolog.md
View File

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#prolog layer"
description: "This layer is for Prolog development, provide syntax checking, code runner and repl support for prolog file."
description: "This layer is for Prolog development, provides syntax checking, code runner and repl support for prolog files."
---
# [Available Layers](../../) >> lang#prolog
@ -22,7 +22,7 @@ This layer is for Prolog development.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]
@ -38,7 +38,7 @@ To use this configuration layer, update custom configuration file with:
### Running current script
To running a Prolog file, you can press `SPC l r` to run current file without loss focus, and the result will be shown in a runner buffer.
To run a Prolog file, you can press `SPC l r` to run the current file without losing focus, and the result will be shown in a runner buffer.
### Inferior REPL process

2
docs/layers/lang/puppet.md
View File

@ -26,7 +26,7 @@ This layer adds Puppet language support to SpaceVim.
## Install
To use this configuration layer, update custom configuration file with:
To use this configuration layer, update your custom configuration file with:
```toml
[[layers]]

Some files were not shown because too many files have changed in this diff Show More