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

Add doc for missing layers (#2139)

Browse Source
This commit is contained in:
Wang Shidong 2018-09-12 20:14:20 +08:00 committed by GitHub
parent cc6d32effe
commit 51c20d965c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
52 changed files with 1450 additions and 301 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.SpaceVim.d/autoload/SpaceVim/dev/layers.vim
View File

@ -92,6 +92,9 @@ function! s:layer_list_cn() abort
for layer in layers
let name = split(layer, '/docs/cn/layers/')[1][:-4] . '/'
let url = name
if name ==# 'language-server-protocol/'
let name = 'lsp'
endif
let content = readfile(layer)
if len(content) > 3
let line = '| [' . join(split(name, '/'), '#') . '](' . url . ') | ' . content[2][14:-2] . ' | '

2
README.md
View File

@ -21,7 +21,7 @@ SpaceVim is a community-driven modular vim distribution. It manages collections
of plugins in layers, which help collect related packages together to provide IDE-like features.
SpaceVim is not just a vimrc but an ultimate Vim configuration, It contains many built-in features.
![welcome-page](https://user-images.githubusercontent.com/13142418/37595020-273b5bca-2bb2-11e8-8aba-638ed5f1c7ea.png)
![welcome-page](https://user-images.githubusercontent.com/13142418/45254913-e1e17580-b3b2-11e8-8983-43d6c358a474.png)
The last release is v0.8.0, check out [following-HEAD](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD) page for what happened since last release.

18
autoload/SpaceVim/layers/lang/markdown.vim
View File

@ -51,6 +51,8 @@ function! SpaceVim#layers#lang#markdown#config() abort
let g:mkdp_browserfunc = 'openbrowser#open'
" }}}
call SpaceVim#mapping#space#regesit_lang_mappings('markdown', function('s:mappings'))
nnoremap <silent> <plug>(markdown-insert-link) :call <SID>markdown_insert_url()<Cr>
xnoremap <silent> <plug>(markdown-insert-link) :call <SID>markdown_insert_url()<Cr>
augroup spacevim_layer_lang_markdown
autocmd!
autocmd FileType markdown setlocal omnifunc=htmlcomplete#CompleteTags
@ -64,6 +66,7 @@ function! s:mappings() abort
let g:_spacevim_mappings_space.l = {'name' : '+Language Specified'}
call SpaceVim#mapping#space#langSPC('nmap', ['l','ft'], "Tabularize /|", 'Format table under cursor', 1)
call SpaceVim#mapping#space#langSPC('nmap', ['l','p'], "MarkdownPreview", 'Real-time markdown preview', 1)
call SpaceVim#mapping#space#langSPC('nmap', ['l','k'], '<plug>(markdown-insert-link)', 'add link url', 0, 1)
endfunction
function! s:generate_remarkrc() abort
@ -87,4 +90,19 @@ function! s:generate_remarkrc() abort
return f
endfunction
function! s:markdown_insert_url() abort
let pos1 = getpos("'<")
let pos2 = getpos("'>")
let scope = sort([pos1[2], pos2[2]], 'n')
"FIXME: list scope is not same as string scope index.
let url = @+
if !empty(url)
let line = getline(pos1[1])
let splits = [line[:scope[0]], line[scope[0] : scope[1]], line[scope[1]:]]
let result = splits[0] . '[' . splits[1] . '](' . url . ')' . splits[2]
call setline(pos1[1], result)
endif
keepjumps call cursor(pos1[1], scope[0])
endfunction

10
autoload/SpaceVim/mapping/space.vim
View File

@ -413,10 +413,11 @@ function! SpaceVim#mapping#space#regesit_lang_mappings(ft, func) abort
call extend(s:language_specified_mappings, {a:ft : a:func})
endfunction
function! SpaceVim#mapping#space#langSPC(m, keys, cmd, desc, is_cmd) abort
function! SpaceVim#mapping#space#langSPC(m, keys, cmd, desc, is_cmd, ...) abort
if s:has_map_to_spc()
return
endif
let is_visual = a:0 > 0 ? a:1 : 0
if a:is_cmd
let cmd = ':<C-u>' . a:cmd . '<CR>'
let lcmd = a:cmd
@ -430,6 +431,13 @@ function! SpaceVim#mapping#space#langSPC(m, keys, cmd, desc, is_cmd) abort
endif
endif
exe a:m . ' <silent> <buffer> [SPC]' . join(a:keys, '') . ' ' . substitute(cmd, '|', '\\|', 'g')
if is_visual
if a:m ==# 'nnoremap'
exe 'xnoremap <silent> <buffer> [SPC]' . join(a:keys, '') . ' ' . substitute(cmd, '|', '\\|', 'g')
elseif a:m ==# 'nmap'
exe 'xmap <silent> <buffer> [SPC]' . join(a:keys, '') . ' ' . substitute(cmd, '|', '\\|', 'g')
endif
endif
if len(a:keys) == 2
let g:_spacevim_mappings_space[a:keys[0]][a:keys[1]] = [lcmd, a:desc]
elseif len(a:keys) == 3

646
doc/SpaceVim.cnx
View File

@ -15,76 +15,274 @@
wsdjeg *spacevim* *SpaceVim*
==============================================================================
目录 *SpaceVim-contents*
1. 简介.....................................................|SpaceVim-intro|
2. 配置...........................................|SpaceVim-config|
3. 命令..............................................|SpaceVim-commands|
4. 函数............................................|SpaceVim-functions|
5. 模块..................................................|SpaceVim-layers|
1. 默认模块............................................|SpaceVim-default|
2. 自动补全..................................|SpaceVim-autocomplete|
3. 语法检查....................................|SpaceVim-layer-checkers|
4. 颜色主题....................................|SpaceVim-colorscheme|
5. 标签栏............................|SpaceVim-layer-core-tabline|
6. 正则折叠....................................|SpaceVim-layer-exprfold|
7. 格式化..............................................|SpaceVim-format|
8. 实时检索..................................|SpaceVim-layer-incsearch|
9. 对齐移动................................|SpaceVim-layer-indentmove|
10. lang#c.......................................|SpaceVim-layer-lang-c|
11. lang#crystal...........................|SpaceVim-layer-lang-crystal|
12. lang#elixir.............................|SpaceVim-layer-lang-elixir|
13. lang#go.....................................|SpaceVim-layer-lang-go|
14. lang#java.................................|SpaceVim-layer-lang-java|
15. lang#julia...............................|SpaceVim-layer-lang-julia|
16. lang#kotlin.............................|SpaceVim-layer-lang-kotlin|
17. lang#lua...................................|SpaceVim-layer-lang-lua|
18. lang#ocaml...............................|SpaceVim-layer-lang-ocaml|
19. lang#php...................................|SpaceVim-layer-lang-php|
20. lang#pony.................................|SpaceVim-layer-lang-pony|
21. lang#puppet.............................|SpaceVim-layer-lang-puppet|
22. lang#python.............................|SpaceVim-layer-lang-python|
23. lang#rust.................................|SpaceVim-layer-lang-rust|
24. lang#scala...............................|SpaceVim-layer-lang-scala|
25. lang#tmux.................................|SpaceVim-layer-lang-tmux|
26. lang#xml...................................|SpaceVim-layer-lang-xml|
27. operator...................................|SpaceVim-layer-operator|
28. 终端.........................................|SpaceVim-layer-shell|
29. tmux...........................................|SpaceVim-layer-tmux|
6. API........................................................|SpaceVim-api|
1. 命令行目录..................................|SpaceVim-api-cmdlinemenu|
CONTENTS *SpaceVim-contents*
1. Introduction.............................................|SpaceVim-intro|
2. Options................................................|SpaceVim-options|
1. checkinstall..........................|SpaceVim-options-checkinstall|
2. default_indent......................|SpaceVim-options-default_indent|
3. enable_ale..............................|SpaceVim-options-enable_ale|
4. enable_googlesuggest..........|SpaceVim-options-enable_googlesuggest|
5. enable_guicolors..................|SpaceVim-options-enable_guicolors|
6. enable_insert_leader..........|SpaceVim-options-enable_insert_leader|
7. enable_neomake......................|SpaceVim-options-enable_neomake|
8. enable_statusline_mode......|SpaceVim-options-enable_statusline_mode|
9. enable_ycm..............................|SpaceVim-options-enable_ycm|
10. error_symbol.........................|SpaceVim-options-error_symbol|
11. guifont...................................|SpaceVim-options-guifont|
12. lint_on_the_fly...................|SpaceVim-options-lint_on_the_fly|
13. max_column.............................|SpaceVim-options-max_column|
14. plugin_bundle_dir...............|SpaceVim-options-plugin_bundle_dir|
15. plugin_manager_processes.|SpaceVim-options-plugin_manager_processes|
16. realtime_leader_guide.......|SpaceVim-options-realtime_leader_guide|
17. relativenumber.....................|SpaceVim-options-relativenumber|
18. sidebar_width.......................|SpaceVim-options-sidebar_width|
19. snippet_engine.....................|SpaceVim-options-snippet_engine|
20. windows_leader.....................|SpaceVim-options-windows_leader|
3. Configuration...........................................|SpaceVim-config|
4. Commands..............................................|SpaceVim-commands|
5. Functions............................................|SpaceVim-functions|
6. Layers..................................................|SpaceVim-layers|
1. autocomplete..................................|SpaceVim-autocomplete|
2. checkers....................................|SpaceVim-layer-checkers|
3. colorscheme....................................|SpaceVim-colorscheme|
4. core#statusline......................|SpaceVim-layer-core-statusline|
5. core#tabline............................|SpaceVim-layer-core-tabline|
6. exprfold....................................|SpaceVim-layer-exprfold|
7. format........................................|SpaceVim-layer-format|
8. github........................................|SpaceVim-layer-github|
9. incsearch..................................|SpaceVim-layer-incsearch|
10. indentmove...............................|SpaceVim-layer-indentmove|
11. lang#c.......................................|SpaceVim-layer-lang-c|
12. lang#crystal...........................|SpaceVim-layer-lang-crystal|
13. lang#csharp.............................|SpaceVim-layer-lang-csharp|
14. lang#elixir.............................|SpaceVim-layer-lang-elixir|
15. lang#elm...................................|SpaceVim-layer-lang-elm|
16. lang#go.....................................|SpaceVim-layer-lang-go|
17. lang#java.................................|SpaceVim-layer-lang-java|
18. lang#julia...............................|SpaceVim-layer-lang-julia|
19. lang#kotlin.............................|SpaceVim-layer-lang-kotlin|
20. lang#lua...................................|SpaceVim-layer-lang-lua|
21. lang#ocaml...............................|SpaceVim-layer-lang-ocaml|
22. lang#php...................................|SpaceVim-layer-lang-php|
23. lang#pony.................................|SpaceVim-layer-lang-pony|
24. lang#puppet.............................|SpaceVim-layer-lang-puppet|
25. lang#python.............................|SpaceVim-layer-lang-python|
26. lang#rust.................................|SpaceVim-layer-lang-rust|
27. lang#scala...............................|SpaceVim-layer-lang-scala|
28. lang#xml...................................|SpaceVim-layer-lang-xml|
29. operator...................................|SpaceVim-layer-operator|
30. shell.........................................|SpaceVim-layer-shell|
31. tmux...........................................|SpaceVim-layer-tmux|
32. tools#dash...............................|SpaceVim-layer-tools-dash|
7. API........................................................|SpaceVim-api|
1. cmdlinemenu................................|SpaceVim-api-cmdlinemenu|
2. data#list....................................|SpaceVim-api-data-list|
3. 命令行prompt.....................................|SpaceVim-api-prompt|
3. prompt..........................................|SpaceVim-api-prompt|
4. sid............................................|SpaceVim-api-vim-sid|
5. vim#message................................|SpaceVim-api-vim-message|
7. FAQ........................................................|SpaceVim-faq|
8. FAQ........................................................|SpaceVim-faq|
9. Changelog............................................|SpaceVim-changelog|
==============================================================================
简介 *SpaceVim-intro*
INTRODUCTION *SpaceVim-intro*
SpaceVim 是一个社区驱动的 vim 配置，以模块的方式组织插件和配置，这一思想来源于 spacemacs.
通过模块来管理插件可以为用户节省很多搜索插件和配置插件的时间.
SpaceVim is a bundle of custom settings and plugins with a modular
configuration for Vim. It was inspired by Spacemacs.
==============================================================================
配置 *SpaceVim-config*
OPTIONS *SpaceVim-options*
SpaceVim 使用 `~/.SpaceVim.d/init.vim` 作为默认的全局配置文件. 你可以在其中设置所有的
SpaceVim 模块和变量. 同时 `~/.SpaceVim.d/` 将被加入 vim 的 runtimepath, 因此，你可以
在其中添加自己的脚本，具体的格式详见 |runtimepath|. SpaceVim 同时支持正对当前项目的局部
设置，你可以在自己的项目根目录添加 `.SpaceVim.d/init.vim`, 同样的 `.SpaceVim.d/` 也会
被加入到 vim 的runtimepath.
SpaceVim uses `~/.SpaceVim.d/init.toml` as its default global config file. You
can set all the SpaceVim options and layers in it. `~/.SpaceVim.d/` will also
be added to runtimepath, so you can write your own scripts in it. SpaceVim
also supports local config for each project. Place local config settings in
`.SpaceVim.d/init.toml` in the root directory of your project. `.SpaceVim.d/`
will also be added to runtimepath.
here is an example setting SpaceVim options:
>
[options]
enable-guicolors = true
max-column = 120
<
==============================================================================
CHECKINSTALL *SpaceVim-options-checkinstall*
Enable/Disable checkinstall on SpaceVim startup. Default is true.
>
checkinstall = true
<
==============================================================================
DEFAULT_INDENT *SpaceVim-options-default_indent*
Change the default indentation of SpaceVim. Default is 2.
>
default_indent = 2
<
==============================================================================
ENABLE_ALE *SpaceVim-options-enable_ale*
Use ale for syntax checking, disabled by default.
>
enable_ale = true
<
==============================================================================
ENABLE_GOOGLESUGGEST *SpaceVim-options-enable_googlesuggest*
Enable/Disable Google suggestions for neocomplete. Default is false.
>
enable_googlesuggest = false
<
==============================================================================
ENABLE_GUICOLORS *SpaceVim-options-enable_guicolors*
Enable true color support in terminal. Default is true.
>
enable_guicolors = true
<
==============================================================================
ENABLE_INSERT_LEADER *SpaceVim-options-enable_insert_leader*
Enable/Disable spacevim's insert mode leader, default is enable
==============================================================================
ENABLE_NEOMAKE *SpaceVim-options-enable_neomake*
SpaceVim default checker is neomake. If you want to use syntastic, use:
>
enable_neomake = false
<
==============================================================================
ENABLE_STATUSLINE_MODE *SpaceVim-options-enable_statusline_mode*
Enable/Disable display mode. Default is 0, mode will be displayed in
statusline. To enable this feature:
>
enable_statusline_mode = true
<
==============================================================================
ENABLE_YCM *SpaceVim-options-enable_ycm*
Enable/Disable YouCompleteMe. Default is false.
>
enable_ycm = true
<
==============================================================================
ERROR_SYMBOL *SpaceVim-options-error_symbol*
Set the error symbol for SpaceVim's syntax maker. Default is '✖'.
>
error_symbol = "+"
<
==============================================================================
GUIFONT *SpaceVim-options-guifont*
Set the guifont of SpaceVim. Default is empty.
>
guifont = "DejaVu\ Sans\ Mono\ for\ Powerline\ 11"
<
==============================================================================
LINT_ON_THE_FLY *SpaceVim-options-lint_on_the_fly*
Enable/Disable lint on the fly feature of SpaceVim's maker. Default is true.
>
lint_on_the_fly = false
<
==============================================================================
MAX_COLUMN *SpaceVim-options-max_column*
Change the max number of columns for SpaceVim. Default is 120.
>
max_column = 120
<
==============================================================================
PLUGIN_BUNDLE_DIR *SpaceVim-options-plugin_bundle_dir*
Set the cache directory of plugins. Default is `~/.cache/vimfiles`.
>
plugin_bundle_dir = "~/.cache/vimplugs"
<
==============================================================================
PLUGIN_MANAGER_PROCESSES *SpaceVim-options-plugin_manager_processes*
Set the max process of SpaceVim plugin manager
==============================================================================
REALTIME_LEADER_GUIDE *SpaceVim-options-realtime_leader_guide*
Enable/Disable realtime leader guide. Default is true. to disable it:
>
realtime_leader_guide = false
<
==============================================================================
RELATIVENUMBER *SpaceVim-options-relativenumber*
Enable/Disable relativenumber, by default it is enabled.
>
relativenumber = true
<
==============================================================================
SIDEBAR_WIDTH *SpaceVim-options-sidebar_width*
Set the width of the SpaceVim sidebar. Default is 30. This value will be used
by tagbar and vimfiler.
==============================================================================
SNIPPET_ENGINE *SpaceVim-options-snippet_engine*
Set the snippet engine of SpaceVim, default is neosnippet. to enable
ultisnips:
>
snippet_engine = "ultisnips"
<
==============================================================================
WINDOWS_LEADER *SpaceVim-options-windows_leader*
Window functions leader for SpaceVim. Default is `s`. Set to empty to disable
this feature, or you can set to another char.
>
windows_leader = ""
<
==============================================================================
CONFIGURATION *SpaceVim-config*
If you still want to use `~/.SpaceVim.d/init.vim` as configuration file,
please take a look at the following options.
*g:spacevim_default_indent*
改变 SpaceVim 默认的对齐宽度. 默认是 2.
*g:spacevim_version*
Version of SpaceVim , this value can not be changed.
*g:spacevim_default_indent*
Change the default indentation of SpaceVim. Default is 2.
>
let g:spacevim_default_indent = 2
<
*g:spacevim_relativenumber*
启用/禁用 相对行号，默认情况下是启用的，在窗口左侧，你可以看到相对行号，即为相对于本行的行号，
便于上下多行移动光标.
*g:spacevim_expand_tab*
In Insert mode: Use the appropriate number of spaces to insert a <Tab>
*g:spacevim_relativenumber*
Enable/Disable relativenumber, by default it is enabled.
*g:spacevim_max_column*
Change the max number of columns for SpaceVim. Default is 120.
@ -93,8 +291,7 @@ Change the max number of columns for SpaceVim. Default is 120.
<
*g:spacevim_enable_guicolors*
启用/禁用 终端真色彩，默认情况下是启用的，颜色更加细腻，但需要确保你的终端支持真色彩，如果
你的终端不支持真色彩，可以禁用此选项.
Enable true color support in terminal. Default is 1.
>
let g:spacevim_enable_guicolors = 1
<
@ -112,14 +309,6 @@ this feature, or you can set to another char.
let g:spacevim_windows_leader = ''
<
*g:spacevim_unite_leader*
Unite work flow leader of SpaceVim. Default is `f`. Set to empty to disable
this feature, or you can set to another char.
*g:spacevim_denite_leader*
Denite work flow leader of SpaceVim. Default is `F`. Set to empty to disable
this feature, or you can set to another char.
*g:spacevim_enable_insert_leader*
Enable/Disable spacevim's insert mode leader, default is enable
@ -190,7 +379,7 @@ by tagbar and vimfiler.
Set the snippet engine of SpaceVim, default is neosnippet. to enable
ultisnips:
>
let g:spacevim_snippet_engine = 'ultisnips'
let g:spacevim_snippet_engine = "ultisnips"
<
*g:spacevim_enable_cursorline*
@ -203,7 +392,7 @@ normal mode.To disable this feature:
*g:spacevim_statusline_separator*
Set the statusline separators of statusline, default is 'arrow'
>
Separatos options:
Separators options:
1. arrow
2. curve
3. slant
@ -245,11 +434,11 @@ Enable/Disable unicode symbols in statusline
Enable/Disable language specific leader, by default you can use `,` ket
instead of `SPC` `l`.
*g:spacevim_enable_statusline_display_mode*
*g:spacevim_enable_statusline_mode*
Enable/Disable display mode. Default is 0, mode will be displayed in
statusline. To enable this feature:
>
let g:spacevim_enable_statusline_display_mode = 1
let g:spacevim_enable_statusline_mode = 1
<
*g:spacevim_custom_color_palette*
@ -264,6 +453,8 @@ theme
\ ['#282828', '#83a598', 235, 109],
\ ['#282828', '#fe8019', 235, 208],
\ ['#282828', '#8ec07c', 235, 108],
\ ['#282828', '#689d6a', 235, 72],
\ ['#282828', '#8f3f71', 235, 132],
\ ]
<
@ -349,11 +540,7 @@ plugins will be installed.
*g:spacevim_filemanager*
The default file manager of SpaceVim. Default is 'vimfiler'.
*g:spacevim_plugin_manager*
The default plugin manager of SpaceVim. Default is 'dein'. Options are dein,
neobundle, or vim-plug.
*g:spacevim_plugin_manager_max_processes*
*g:spacevim_plugin_manager_processes*
Set the max process of SpaceVim plugin manager
*g:spacevim_checkinstall*
@ -362,6 +549,17 @@ Enable/Disable checkinstall on SpaceVim startup. Default is 1.
let g:spacevim_checkinstall = 1
<
*g:spacevim_vimcompatible*
Enable/Disable vimcompatible mode, by default it is disabled. In vimcompatible
mode all vim origin key bindings will not be changed.
Includes:
>
q smart quit windows
s windows key bindings leader
<C-x> switch buffer
<
*g:spacevim_enable_debug*
Enable/Disable debug mode for SpaceVim. Default is 0.
>
@ -404,7 +602,6 @@ Enable/Disable tabline filetype icon. default is 0.
*g:spacevim_enable_os_fileformat_icon*
Enable/Disable os fileformat icon. default is 0.
*g:spacevim_github_username*
Set the github username, It will be used for getting your starred repos, and
fuzzy find the repo you want.
@ -482,6 +679,24 @@ Enable/Disable autocompletion of parentheses, default is 1 (enabled).
The host file url. This option is for Chinese users who can not use Google and
Twitter.
*g:neomake_echo_current_error*
neomake/neomake {{{ This setting will echo the error for the line your cursor
is on, if any.
*g:ale_echo_delay*
w0rp/ale {{{
*g:github_issues_no_omni*
jaxbot/github-issues.vim {{{ Disable completion by github-issues.vim. Because
github-complete.vim provides more powerful completion.
*g:github_dashboard*
junegunn/vim-github-dashboard {{{
*g:dash_map*
rizzatti/dash.vim {{{ Allows configuration of mappings between Vim filetypes
and Dash's docsets.
==============================================================================
COMMANDS *SpaceVim-commands*
@ -502,6 +717,9 @@ COMMANDS *SpaceVim-commands*
print the debug information of spacevim, [!] forces the output into a new
buffer.
:SPRuntimeLog *:SPRuntimeLog*
view runtime log
:SPConfig *:SPConfig*
edit custom config file of SpaceVim, by default this command will open
global custom configuration file, '-l' option will load local custom
@ -542,14 +760,21 @@ SpaceVim#logger#setLevel({level}) *SpaceVim#logger#setLevel()*
SpaceVim#logger#setOutput({file}) *SpaceVim#logger#setOutput()*
Set the log output file of SpaceVim. Default is empty.
SpaceVim#plugins#iedit#start() *SpaceVim#plugins#iedit#start()*
public API for iedit mode
>
KEY:
expr match expression
word match word
stack cursor pos stack
<
if only argv 1 is given, use selected word as pattern
==============================================================================
LAYERS *SpaceVim-layers*
SpaceVim support such layers:
==============================================================================
DEFAULT *SpaceVim-default*
==============================================================================
AUTOCOMPLETE *SpaceVim-autocomplete*
@ -594,133 +819,28 @@ all of below colorschemes support spell check very well. For example, a
colorscheme called atom doesn't support spell check very well.
SpaceVim is not gonna fix them since these should be in charge of each author.
You can see a list which has no support of spell check in here:
https://github.com/SpaceVim/SpaceVim/issues/209#issuecomment-280545818
==============================================================================
CORE#STATUSLINE *SpaceVim-layer-core-statusline*
This layer provides default statusline for SpaceVim If you want to use
airline's statusline, just disable this layer
>
anderson
apprentice
atom
base16-3024
base16-apathy
base16-ashes
base16-atelier-cave
base16-atelier-dune
base16-atelier-estuary
base16-atelier-forest
base16-atelier-heath
base16-atelier-lakeside
base16-atelier-plateau
base16-atelier-savanna
base16-atelier-seaside
base16-atelier-sulphurpool
base16-bespin
base16-brewer
base16-bright
base16-chalk
base16-codeschool
base16-cupcake
base16-darktooth
base16-default-dark
base16-default-light
base16-dracula
base16-eighties
base16-embers
base16-flat
base16-github
base16-google-dark
base16-google-light
base16-grayscale-dark
base16-grayscale-light
base16-green-screen
base16-harmonic16-dark
base16-harmonic16-light
base16-hopscotch
base16-ir-black
base16-isotope
base16-london-tube
base16-macintosh
base16-marrakesh
base16-materia
base16-mexico-light
base16-mocha
base16-monokai
base16-ocean
base16-oceanicnext
base16-onedark
base16-paraiso
base16-phd
base16-pico
base16-pop
base16-railscasts
base16-seti-ui
base16-shapeshifter
base16-solar-flare
base16-solarized-dark
base16-solarized-light
base16-spacemacs
base16-summerfruit-dark
base16-summerfruit-light
base16-tomorrow
base16-tomorrow-night
base16-twilight
base16-unikitty-dark
base16-unikitty-light
base16-woodland
blue
darkblue
default
delek
desert
elflord
evening
flatcolor
flattened_dark
flattened_light
focuspoint
gruvbox
hybrid
hybrid-material
hybrid_material
hybrid_reverse
industry
janah
jellybeans
koehler
lightning
lucius
molokai
molokayo
morning
murphy
OceanicNext
OceanicNextLight
onedark
pablo
PaperColor
parsec
peachpuff
pyte
rdark-terminal2
ron
scheakur
seoul256
seoul256-light
shine
slate
solarized
torte
twilight256
wombat256mod
yowish
zellner
[[layers]]
name = "core#statusline"
enable = false
<
==============================================================================
CORE#TABLINE *SpaceVim-layer-core-tabline*
This layer provides default tabline for SpaceVim
This layer provides default tabline for SpaceVim If you want to use airline's
tabline, just disable this layer
>
[[layers]]
name = "core#tabline"
enable = false
<
==============================================================================
EXPRFOLD *SpaceVim-layer-exprfold*
@ -737,10 +857,35 @@ Mappings:
<
==============================================================================
FORMAT *SpaceVim-format*
FORMAT *SpaceVim-layer-format*
SpaceVim uses neoformat as the default code format tools. Neoformat uses a
variety of formatters for many filetypes. for more info see |neoformat|
variety of formatters for many filetypes. for more info see |neoformat| if you
want to run a formatter on save, just put this config into bootstrap function.
>
augroup fmt
autocmd!
autocmd BufWritePre * undojoin | Neoformat
augroup END
<
==============================================================================
GITHUB *SpaceVim-layer-github*
This layer provides GitHub integration for SpaceVim
MAPPINGS
>
Mode Key Function
-------------------------------------------------------------
normal SPC g h i show issues
normal SPC g h a show activities
normal SPC g h d show dashboard
normal SPC g h f show current file in browser
normal SPC g h I show issues in browser
normal SPC g h p show PRs in browser
<
==============================================================================
INCSEARCH *SpaceVim-layer-incsearch*
@ -834,6 +979,32 @@ INTRO
The lang#crystal layer provides crystal filetype detection and syntax
highlight, crystal tool and crystal spec integration.
==============================================================================
LANG#CSHARP *SpaceVim-layer-lang-csharp*
This layer includes utilities and language-specific mappings for csharp
development.
KEY MAPPINGS
>
Mode Key Function
---------------------------------------------
normal SPC l b compile the project
normal SPC l f format current file
normal SPC l d show doc
normal SPC l e rename symbol under cursor
normal SPC l g g go to definition
normal SPC l g i find implementations
normal SPC l g t find type
normal SPC l g s find symbols
normal SPC l g u find usages of symbol under cursor
normal SPC l g m find members in the current buffer
normal SPC l s r reload the solution
normal SPC l s s start the OmniSharp server
normal SPC l s S stop the OmniSharp server
<
==============================================================================
LANG#ELIXIR *SpaceVim-layer-lang-elixir*
@ -842,6 +1013,14 @@ The lang#elixir layer provides code completion, documentation lookup, jump to
definition, mix integration, and iex integration for Elixir. SpaceVim uses
neomake as default syntax checker which is loaded in |SpaceVim-layer-checkers|
==============================================================================
LANG#ELM *SpaceVim-layer-lang-elm*
INTRO
The lang#elm layer provides code completion, documentation lookup, jump to
definition, mix integration, and iex integration for elm. SpaceVim uses
neomake as default syntax checker which is loaded in |SpaceVim-layer-checkers|
==============================================================================
LANG#GO *SpaceVim-layer-lang-go*
@ -852,15 +1031,28 @@ MAPPINGS
>
Mode Key Function
---------------------------------------------
normal SPC l i go implements
normal SPC l f go info
normal SPC l e go rename
normal SPC l r go run
normal SPC l a go alternate
normal SPC l b go build
normal SPC l t go test
normal SPC l d go doc
normal SPC l v go doc vertical
normal SPC l c go coverage
normal SPC l d go doc
normal SPC l D go doc vertical
normal SPC l e go rename
normal SPC l g go definition
normal SPC l G go generate
normal SPC l h go info
normal SPC l i go implements
normal SPC l I implement stubs
normal SPC l k add tags
normal SPC l K remove tags
normal SPC l l list declarations in file
normal SPC l L list declarations in dir
normal SPC l m format improts
normal SPC l M add import
normal SPC l r go referrers
normal SPC l s fill struct
normal SPC l t go test
normal SPC l v freevars
normal SPC l x go run
<
==============================================================================
@ -939,9 +1131,9 @@ and set 'g:spacevim_layer_lang_java_formatter' to the path of the jar.
==============================================================================
LANG#JULIA *SpaceVim-layer-lang-julia*
The layer provides synatax highlight and linting for julia. The completeion
only works in nvim with deoplete. However, the julia-vim could not be load
on-demanding due to its LaTeXToUnicode feature.
The layer provides synatax highlight julia. The completeion only works in
nvim with deoplete. However, the julia-vim could not be load on-demanding due
to its LaTeXToUnicode feature.
==============================================================================
@ -1017,8 +1209,7 @@ MAPPINGS
==============================================================================
LANG#RUST *SpaceVim-layer-lang-rust*
SpaceVim does not load this layer by default. If you are a rust developer, you
should add `call SpaceVim#layers#load('lang#rust')` to your |SpaceVim-config|
This layer is for Rust development.
Requirements:
@ -1051,23 +1242,15 @@ MAPPINGS
Mode Key Function
-----------------------------------------------
normal gd rust-definition
normal gs rust-definition-split
normal gx rust-definition-vertical
normal SPC l d rust-doc
normal SPC l r execute current file
normal SPC l s rust-def-split
normal SPC l x rust-def-vertical
<
==============================================================================
LANG#SCALA *SpaceVim-layer-lang-scala*
==============================================================================
LANG#TMUX *SpaceVim-layer-lang-tmux*
INTRO
The lang#tmux layer provides syntax highlighting, commenting, man page
navigation and ability to execute lines as tmux commands.
|SpaceVim-layer-checkers|
==============================================================================
LANG#XML *SpaceVim-layer-lang-xml*
@ -1093,10 +1276,11 @@ default_shell
==============================================================================
TMUX *SpaceVim-layer-tmux*
Adds integration between tmux and vim panes. Switch between panes seamlessly.
This layer is not added by default. To include it, add
`SpaceVim#layers#load('tmux')` to your `~/.SpaceVim.d/init.vim`. If you are
having issues with <C-h> in a neovim buffer, see
Adds integration between tmux and vim panes. Switch between panes
seamlessly.syntax highlighting, commenting, man page navigation and ability to
execute lines as tmux commands. This layer is not added by default. To include
it, add `SpaceVim#layers#load('tmux')` to your `~/.SpaceVim.d/init.vim`. If
you are having issues with <C-h> in a neovim buffer, see
`https://github.com/neovim/neovim/issues/2048#issuecomment-78045837`
MAPPINGS
@ -1110,6 +1294,11 @@ MAPPINGS
<C-l> normal Switch to vim/tmux pane in right direction
<
==============================================================================
TOOLS#DASH *SpaceVim-layer-tools-dash*
This layer provides Dash integration for SpaceVim
==============================================================================
API *SpaceVim-api*
@ -1226,5 +1415,16 @@ FAQ *SpaceVim-faq*
Add `let mapleader = "\<Space>"` to `~/.SpaceVim.d/init.vim`
<
==============================================================================
CHANGELOG *SpaceVim-changelog*
Following HEAD: changes in master branch since last release v0.7.0
https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD
2018-03-19: v0.7.0
https://spacevim.org/SpaceVim-release-v0.7.0/
vim:tw=78:ts=8:ft=help:norl:

2
docs/_posts/2017-01-26-SpaceVim-release-v0.1.0.md
View File

@ -7,7 +7,7 @@ comments: true
commentsID: "SpaceVim release v0.1.0"
---
# [Changelogs](development#changelog) > SpaceVim release v0.1.0
# [Changelogs](../development#changelog) > SpaceVim release v0.1.0
SpaceVim is a modular configuration inspired by spacemacs, compatible with vim and neovim.

1
docs/_posts/2017-02-11-vim8-new-feature-timers.md
View File

@ -6,6 +6,7 @@ permalink: /cn/:title/
redirect_from: "/vim8-new-feature-timers-zh_cn/"
lang: cn
comments: true
image: https://user-images.githubusercontent.com/13142418/45222979-8a76d300-b2e8-11e8-8a3c-5b2702a051e7.png
commentsID: "Vim8 最新特性: timers"
---

2
docs/_posts/2017-03-30-SpaceVim-release-v0.2.0.md
View File

@ -7,7 +7,7 @@ commentsID: "SpaceVim release v0.2.0"
comments: true
---
# [Changelogs](https://spacevim.org/development#changelog) > SpaceVim release v0.2.0
# [Changelogs](../development#changelog) > SpaceVim release v0.2.0
SpaceVim is a community-driven vim distribution inspired by spacemacs.

2
docs/_posts/2017-05-31-SpaceVim-release-v0.3.0.md
View File

@ -7,7 +7,7 @@ commentsID: "SpaceVim release v0.3.0"
comments: true
---
# [Changelogs](https://spacevim.org/development#changelog) > SpaceVim release v0.3.0
# [Changelogs](../development#changelog) > SpaceVim release v0.3.0
## FEATURES

2
docs/_posts/2017-06-27-SpaceVim-release-v0.3.1.md
View File

@ -7,7 +7,7 @@ commentsID: "SpaceVim release v0.3.1"
comments: true
---
# [Changelogs](https://spacevim.org/development#changelog) > SpaceVim release v0.3.1
# [Changelogs](../development#changelog) > SpaceVim release v0.3.1
**Install:** https://github.com/SpaceVim/SpaceVim/wiki/Installing-SpaceVim

2
docs/_posts/2017-08-05-SpaceVim-release-v0.4.0.md
View File

@ -7,7 +7,7 @@ commentsID: "SpaceVim release v0.4.0"
comments: true
---
# [Changelogs](https://spacevim.org/development#changelog) > SpaceVim release v0.4.0
# [Changelogs](../development#changelog) > SpaceVim release v0.4.0
### FEATURES:

1
docs/_posts/2017-11-04-use-ctrl-in-terminal-and-vim.md
View File

@ -2,6 +2,7 @@
title: "VIM 中 ctrl 相关的组合键的使用"
categories: [blog_cn, feature_cn]
excerpt: "枚举 Vim 内置的 Ctrl 组合键功能，以及终端下的一些区别"
image: https://user-images.githubusercontent.com/13142418/45222902-513e6300-b2e8-11e8-967f-845342410262.png
comments: true
commentsID: "VIM 中 ctrl 相关的组合键的使用"
lang: cn

2
docs/_posts/2017-11-06-SpaceVim-release-v0.5.0.md
View File

@ -7,7 +7,7 @@ commentsID: "SpaceVim release v0.5.0"
comments: true
---
# [Changelogs](development#changelog) > SpaceVim release v0.5.0
# [Changelogs](../development#changelog) > SpaceVim release v0.5.0
## New Features

2
docs/_posts/2017-12-30-SpaceVim-release-v0.6.0.md
View File

@ -8,7 +8,7 @@ commentsID: "SpaceVim release v0.6.0"
comments: true
---
# [Changelogs](https://spacevim.org/development#changelog) > SpaceVim release v0.6.0
# [Changelogs](../development#changelog) > SpaceVim release v0.6.0
## New Features

2
docs/_posts/2018-3-18-SpaceVim-release-v0.7.0.md
View File

@ -8,7 +8,7 @@ commentsID: "SpaceVim release v0.7.0"
comments: true
---
# [Changelogs](https://spacevim.org/development#changelog) > SpaceVim release v0.7.0
# [Changelogs](../development#changelog) > SpaceVim release v0.7.0
![welcome-page](https://user-images.githubusercontent.com/13142418/37595020-273b5bca-2bb2-11e8-8aba-638ed5f1c7ea.png)

2
docs/_posts/2018-6-18-SpaceVim-release-v0.8.0.md
View File

@ -8,7 +8,7 @@ commentsID: "SpaceVim release v0.8.0"
comments: true
---
# [Changelogs](https://spacevim.org/development#changelog) > SpaceVim release v0.8.0
# [Changelogs](../development#changelog) > SpaceVim release v0.8.0
This project exists thanks to all the people who have contributed. The last release v0.7.0 is targeted

3
docs/cn/blog.md
View File

@ -6,7 +6,8 @@ lang: cn
# SpaceVim 中文博客
在这里，你可以看到最新的 SpaceVim 特性简介，以及使用技巧：
SpaceVim 中文博客主要公布最新版本发布、新特性预览、以及一些 SpaceVim 及 Vim
相关的使用教程，可通过 RSS [订阅本博客](../../feed.xml)：
<ul>
{% for post in site.categories.blog_cn %}

2
docs/cn/community.md
View File

@ -56,7 +56,7 @@ lang: cn
以下为 SpaceVim 的 QQ 交流群，主要讨论 SpaceVim、Vim 以及 Neovim 相关的问题，消息与以上频道不互通。
- <i class="fab fa-qq"></i> [`121056965` Vim/SpaceVim 用户 ① 群](https://jq.qq.com/?_wv=1027&k=43DB6SG)
- <i class="fab fa-qq"></i> [`121056965` Vim/SpaceVim 用户 ① 群（满）](https://jq.qq.com/?_wv=1027&k=43DB6SG)
- <i class="fab fa-qq"></i> [`755208473` Vim/SpaceVim 用户 ② 群](https://jq.qq.com/?_wv=1027&k=5uBbMuA)
- <i class="fab fa-qq"></i> [`748697811` Vim/SpaceVim 用户 ③ 群](https://jq.qq.com/?_wv=1027&k=5DqbuMV)
- <i class="fab fa-qq"></i> [`667379969` Vim/SpaceVim 用户 ④ 群](https://jq.qq.com/?_wv=1027&k=5z2C7BM)

2
docs/cn/documentation.md
View File

@ -132,7 +132,7 @@ lang: cn
**欢迎页面**
![welcome-page](https://cloud.githubusercontent.com/assets/13142418/26402270/28ad72b8-40bc-11e7-945e-003f41e057be.png)
![welcome-page](https://user-images.githubusercontent.com/13142418/45254913-e1e17580-b3b2-11e8-8983-43d6c358a474.png)
**工作界面**

2
docs/cn/index.md
View File

@ -11,7 +11,7 @@ lang: cn
[![Version](https://img.shields.io/badge/version-0.9.0--dev-FF69B4.svg)](https://github.com/SpaceVim/SpaceVim/releases)
[![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE)
![welcome-page](https://user-images.githubusercontent.com/13142418/37595020-273b5bca-2bb2-11e8-8aba-638ed5f1c7ea.png)
![welcome-page](https://user-images.githubusercontent.com/13142418/45254913-e1e17580-b3b2-11e8-8983-43d6c358a474.png)
# SpaceVim - 模块化 Vim IDE

15
docs/cn/layers/core.md Normal file
View File

@ -0,0 +1,15 @@
---
title: "SpaceVim core 模块"
description: "core 模块主要包括 SpaceVim 启动及基本操作所必须的插件及配置。"
lang: cn
---
# [可用模块](../) >> core
## 模块简介
该模块主要包括 SpaceVim 启动时所必须的配置，默认已启用。
## 功能特性
- 文件树：nerdtree 或者 vimfiler，默认为 vimfiler，由 `filemanager` 选项控制

25
docs/cn/layers/core/banner.md Normal file
View File

@ -0,0 +1,25 @@
---
title: "SpaceVim core#banner 模块"
description: "This layer provides many default banner on welcome page."
lang: cn
---
# [Available Layers](../) >> core#banner
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [模块选项](#模块选项)
<!-- vim-markdown-toc -->
## 模块简介
这一模块主要是为 SpaceVim 设置一些默认的启动界面的 logo。
## 模块选项
- frequece for change the banner: daily, weekly, or other.

33
docs/cn/layers/core/statusline.md Normal file
View File

@ -0,0 +1,33 @@
---
title: "SpaceVim core#statusline 模块"
description: "这一模块为 SpaceVim 提供了默认的模式化的状态了支持。"
lang: cn
---
# [可用模块](../) >> core#statusline
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [模块启用](#模块启用)
- [相关选项](#相关选项)
<!-- vim-markdown-toc -->
## 模块简介
这一模块为 SpaceVim 提供了默认的模式化的状态了支持。
## 模块启用
可通过在配置文件内加入如下配置来启用该模块，该模块默认已经启用：
```toml
[[layers]]
name = "core#statusline"
```
## 相关选项
在这里，将列出一些跟状态了相关的 SpaceVim 相关选项，这些选项并非模块选项，需加以区分：

37
docs/cn/layers/core/tabline.md Normal file
View File

@ -0,0 +1,37 @@
---
title: "SpaceVim core#tabline 模块"
description: "SpaceVim core#tabline layer provides a better tabline for SpaceVim"
lang: cn
---
# [可用模块](../) >> core#tabline
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [相关选项](#相关选项)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
该模块为 SpaceVim 提供了默认的标签栏，支持 `Leader + idx` 快捷键快速跳转。
![tabline](https://user-images.githubusercontent.com/13142418/45297568-66113580-b538-11e8-9e10-f1b00165d870.png)
## 相关选项
以下均为 SpaceVim 选项，不同于模块选项，需要写在 `[options]` 下面：
- `enable_tabline_filetype_icon`：展示或者隐藏标签栏上的文件类型图标，需要安装 nerd 字体。默认开启的，
若需要禁用，可将其值设为 `false`
```toml
[options]
enable_tabline_filetype_icon = false
```
## 快捷键
所有的标签栏相关的快捷键可以在[《使用文档》](../../../documentation/#标签栏)中查询到。

32
docs/cn/layers/edit.md Normal file
View File

@ -0,0 +1,32 @@
---
title: "SpaceVim edit 模块"
description: "该模块提升了 SpaceVim 的文本编辑体验，提供更多种文本对象。"
lang: cn
---
# [可用模块](../) >> edit
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [模块选项](#模块选项)
<!-- vim-markdown-toc -->
## 模块简介
该模块提升了 SpaceVim 的文本编辑体验，提供更多种文本对象。
## 功能特性
- 修改围绕当前光标的符号
- 重复编辑
- 多光标支持
- 对齐文档内容
- 高亮行为符号
- 自动载入 editorconfig 配置
## 模块选项
- `textobj`: specified a list of text opjects to be enabled, the avaliable list is :`indent`, `line`, `entire`

46
docs/cn/layers/floobits.md Normal file
View File

@ -0,0 +1,46 @@
---
title: "SpaceVim floobits 模块"
description: "该模块为 SpaceVim 提供了 floobits 协作工具的支持，实现多人协作编辑等功能。"
lang: cn
---
# [可用模块](../) >> floobits
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
该模块为 SpaceVim 提供了多人协作工具 floobits 的支持，该模块目前仅支持在 neovim 下正常工作。
## 功能特性
- 自动读取工作目录下的 floobits 配置文件。
- 新建 floobits 工作区，并且获取其内容
- 为工作区内所有用户高亮其光标位置
- 同步其他用户的编辑内容
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "floobits"
```
## 快捷键
| 按键 | 功能描述 |
| ------------ | --------------------------------------------------------- |
| `SPC m f j` | Join workspace |
| `SPC m f t` | Toggle follow mode |
| `SPC m f s` | Summon everyone in the workspace to your cursor position. |

34
docs/cn/layers/format.md Normal file
View File

@ -0,0 +1,34 @@
---
title: "SpaceVim format 模块"
description: "该模块为 SpaceVim 提供了代码异步格式化的功能，支持高度自定义配置和多种语言。"
lang: cn
---
# [可用模块](../) >> format
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [启用模块](#启用模块)
- [模块设置](#模块设置)
<!-- vim-markdown-toc -->
## 模块简介
该模块为 SpaceVim 提供代码格式化的功能，使用了 Vim8/neovim 的异步特性。引入了插件 [neoformat](https://github.com/sbdchd/neoformat)
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "format"
```
## 模块设置
neoformat 这一插件为不同语言做了很好的默认配置，只需要安装对应的格式化命令即可。当然，neoformat 也支持自定义配置。
可以在 SpaceVim 启动函数里设置相关插件选项。

41
docs/cn/layers/github.md Normal file
View File

@ -0,0 +1,41 @@
---
title: "SpaceVim github 模块"
description: "该模块主要提供了 Github 数据管理功能，包括问题列表、动态等管理。"
lang: cn
---
# [可用模块](../) >> github
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [启用模块](#启用模块)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
该模块主要提供了 Github 数据管理功能，包括问题列表、动态等管理。
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "github"
```
## 快捷键
| 按键 | 功能描述 |
| ----------- | -------------------------- |
| `SPC g h i` | 显示当前仓库问题列表 |
| `SPC g h a` | 显示最新动态 |
| `SPC g h d` | 显示个人面板 |
| `SPC g h f` | 在浏览器中打开当前文件 |
| `SPC g h I` | 在浏览器中显示问题列表 |
| `SPC g h p` | 在浏览器中显示拉取请求列表 |
| `SPC g g l` | 显示所有的 gist |
| `SPC g g p` | 发布 gist |

124
docs/cn/layers/index.md
View File

@ -57,59 +57,77 @@ Vim 插件以及相关配置。而 SpaceVim 是以模块的方式来组织和管
## 可用模块
| 名称 | 描述 |
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [VersionControl](VersionControl/) | 这一模块为 SpaceVim 提供了通用的代码版本控制支持，该模块支持 Git、Mercurial、Bazaar、SVN 等等多种后台工具。 |
| [autocomplete](autocomplete/) | 这一模块为 SpaceVim 提供了自动补全的框架，包括语法补全等多种补全来源，同时提供了代码块自动完成等特性。 |
| [chat](chat/) | chat 模块为 SpaceVim 提供了一个聊天框架，目前支持微信聊天和 QQ 聊天，同时支持自定义聊天服务器。 |
| [checkers](checkers/) | 这一模块为 SpaceVim 提供了代码语法检查的特性，同时提供代码实时检查，并列出语法错误的位置 |
| [chinese](chinese/) | 该模块为中文用户提供了中文的 Vim 帮助文档，同时提供部分插件的中文帮助文档。 |
| [colorscheme](colorscheme/) | colorscheme 模块为 SpaceVim 提供了一系列的常用颜色主题，默认情况下使用深色 gruvbox 作为默认主题。该模块提供了快速切换主题、随即主题等特性 |
| [cscope](cscope/) | cscope 模块为 SpaceVim 他提供了一个智能的 cscope 和 pycscope 辅助工具，可以快速调用 cscope 常用命令 |
| [ctrlp](ctrlp/) | 提供以 ctrlp 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [debug](debug/) | 这一模块为 SpaceVim 提供了 debug 的常用功能，采用 vebugger 作为后台框架，支持多种 debug 工具。 |
| [default](default/) | SpaceVim default 模块并不包含插件，但提供了一些更好的默认设置， |
| [denite](denite/) | 提供以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [fzf](fzf/) | 提供以 fzf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [git](git/) | 这一模块为 SpaceVim 提供了 git 支持，根据当前 Vim 版本特性，选择 gina 或者 gita 作为默认的后台 git 插件。 |
| [lang#WebAssembly](lang/WebAssembly/) | 这一模块为 WebAssembly 开发提供支持。 |
| [lang#c](lang/c/) | 这一模块为 c/c++/object-c 的开发提供了支持，包括代码补全、语法检查等特性。 |
| [lang#dart](lang/dart/) | 这一模块为 dart 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#elixir](lang/elixir/) | 这一模块为 elixir 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#elm](lang/elm/) | 这一模块为 elm 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#erlang](lang/erlang/) | 这一模块为 erlang 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#extra](lang/extra/) | 该模块主要为一些不常见的语言添加语法支持，主要包括语法高亮、对齐等特性 |
| [lang#fsharp](lang/fsharp/) | 这一模块为 fsharp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#go](lang/go/) | 这一模块为 go 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#haskell](lang/haskell/) | 这一模块为 haskell 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#html](lang/html/) | 这一模块为 html 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#java](lang/java/) | 这一模块为 java 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#javascript](lang/javascript/) | 这一模块为 javascript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#julia](lang/julia/) | 这一模块为 julia 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#latex](lang/latex/) | 这一模块为 latex 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#lisp](lang/lisp/) | 这一模块为 lisp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#lua](lang/lua/) | 这一模块为 lua 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#markdown](lang/markdown/) | 这一模块为 markdown 编辑提供支持，包括格式化、自动生成文章目录、代码块等特性。 |
| [lang#perl](lang/perl/) | 这一模块为 perl 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#php](lang/php/) | 这一模块为 php 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#plantuml](lang/plantuml/) | 这一模块为 plantuml 开发提供支持，包括语法高亮、实时预览等特性。 |
| [lang#purescript](lang/purescript/) | 这一模块为 purescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#python](lang/python/) | 这一模块为 python 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#ruby](lang/ruby/) | 这一模块为 ruby 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#rust](lang/rust/) | 这一模块为 rust 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#scala](lang/scala/) | 这一模块为 scala 开发提供支持，包括语法高亮，函数列表等特性 |
| [lang#sh](lang/sh/) | 这一模块为 shell script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#typescript](lang/typescript/) | 这一模块为 typescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#vim](lang/vim/) | 这一模块为 vim script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#vue](lang/vue/) | 这一模块为 vue 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [language-server-protocol](language-server-protocol/) | lsp 模块为 SpaceVim 提供 language server protocol 的支持，提供更多语言相关服务 |
| [leaderf](leaderf/) | 提供以 leaderf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [shell](shell/) | 这一模块为 SpaceVim 提供了终端集成特性，优化内置终端的使用体验 |
| [tags](tags/) | tags 模块提供全局的 tags 索引管理，提供快速检索定义和引用的功能。 |
| [tools#dash](tools/dash/) | 该模块提供对 Dash 支持，可快速查找光标位置的单词 |
| [tools](tools/) | 集成多种常用工具，包括日历、计算器、等等多种工具类插件，该模块针对 vim8 以及 neovim 提供了更好的插件选择。 |
| [ui](ui/) | SpaceVim ui 模块提供了一个 IDE-like 的界面，包括状态栏、文件树、语法数等等特性。 |
| [unite](unite/) | 提供以 unite 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| 名称 | 描述 |
| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [VersionControl](VersionControl/) | 这一模块为 SpaceVim 提供了通用的代码版本控制支持，该模块支持 Git、Mercurial、Bazaar、SVN 等等多种后台工具。 |
| [autocomplete](autocomplete/) | 这一模块为 SpaceVim 提供了自动补全的框架，包括语法补全等多种补全来源，同时提供了代码块自动完成等特性。 |
| [chat](chat/) | chat 模块为 SpaceVim 提供了一个聊天框架，目前支持微信聊天和 QQ 聊天，同时支持自定义聊天服务器。 |
| [checkers](checkers/) | 这一模块为 SpaceVim 提供了代码语法检查的特性，同时提供代码实时检查，并列出语法错误的位置 |
| [chinese](chinese/) | 该模块为中文用户提供了中文的 Vim 帮助文档，同时提供部分插件的中文帮助文档。 |
| [colorscheme](colorscheme/) | colorscheme 模块为 SpaceVim 提供了一系列的常用颜色主题，默认情况下使用深色 gruvbox 作为默认主题。该模块提供了快速切换主题、随即主题等特性 |
| [core#banner](core/banner/) | This layer provides many default banner on welcome page. |
| [core#statusline](core/statusline/) | 这一模块为 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 模块为 SpaceVim 他提供了一个智能的 cscope 和 pycscope 辅助工具，可以快速调用 cscope 常用命令 |
| [ctrlp](ctrlp/) | 提供以 ctrlp 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [debug](debug/) | 这一模块为 SpaceVim 提供了 debug 的常用功能，采用 vebugger 作为后台框架，支持多种 debug 工具。 |
| [default](default/) | SpaceVim default 模块并不包含插件，但提供了一些更好的默认设置， |
| [denite](denite/) | 提供以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [edit](edit/) | 该模块提升了 SpaceVim 的文本编辑体验，提供更多种文本对象。 |
| [floobits](floobits/) | 该模块为 SpaceVim 提供了 floobits 协作工具的支持，实现多人协作编辑等功能。 |
| [format](format/) | 该模块为 SpaceVim 提供了代码异步格式化的功能，支持高度自定义配置和多种语言。 |
| [fzf](fzf/) | 提供以 fzf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [git](git/) | 这一模块为 SpaceVim 提供了 git 支持，根据当前 Vim 版本特性，选择 gina 或者 gita 作为默认的后台 git 插件。 |
| [github](github/) | 该模块主要提供了 Github 数据管理功能，包括问题列表、动态等管理。 |
| [lang#WebAssembly](lang/WebAssembly/) | 这一模块为 WebAssembly 开发提供支持。 |
| [lang#agda](lang/agda/) | 这一模块为 SpaceVim 提供了 agda 语言开发的支持，主要包括语法高亮及一键运行。 |
| [lang#autohotkey](lang/autohotkey/) | 这一个模块为 SpaceVim 提供了 autohotkey 语言的开发支持，包括语法高亮和自动补全等功能。 |
| [lang#c](lang/c/) | 这一模块为 c/c++/object-c 的开发提供了支持，包括代码补全、语法检查等特性。 |
| [lang#csharp](lang/csharp/) | 该模块为 SpaceVim 提供 csharp 开发支持，包括代码高亮、对齐、补全等特性。 |
| [lang#dart](lang/dart/) | 这一模块为 dart 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#dockerfile](lang/dockerfile/) | 这一模块为 dockerfile 的编辑提供了部分功能支持，包括语法高亮和自动补全。 |
| [lang#elixir](lang/elixir/) | 这一模块为 elixir 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#elm](lang/elm/) | 这一模块为 elm 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#erlang](lang/erlang/) | 这一模块为 erlang 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#extra](lang/extra/) | 该模块主要为一些不常见的语言添加语法支持，主要包括语法高亮、对齐等特性 |
| [lang#fsharp](lang/fsharp/) | 这一模块为 fsharp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#go](lang/go/) | 这一模块为 go 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#haskell](lang/haskell/) | 这一模块为 haskell 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#html](lang/html/) | 这一模块为 html 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#java](lang/java/) | 这一模块为 java 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#javascript](lang/javascript/) | 这一模块为 javascript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#julia](lang/julia/) | 这一模块为 julia 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#kotlin](lang/kotlin/) | This layer adds kotlin language support to SpaceVim |
| [lang#latex](lang/latex/) | 这一模块为 latex 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#lisp](lang/lisp/) | 这一模块为 lisp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#lua](lang/lua/) | 这一模块为 lua 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#markdown](lang/markdown/) | 这一模块为 markdown 编辑提供支持，包括格式化、自动生成文章目录、代码块等特性。 |
| [lang#nim](lang/nim/) | 该模块为 SpaceVim 提供 nim 开发支持，包括语法高亮、代码补全、编译运行以及交互式编程等功能。 |
| [lang#ocaml](lang/ocaml/) | 这一模块为 ocaml 开发提供了支持，包括语法高亮、代码补全、以及定义处跳转等功能。 |
| [lang#perl](lang/perl/) | 这一模块为 perl 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#php](lang/php/) | 这一模块为 php 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#plantuml](lang/plantuml/) | 这一模块为 plantuml 开发提供支持，包括语法高亮、实时预览等特性。 |
| [lang#purescript](lang/purescript/) | 这一模块为 purescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#python](lang/python/) | 这一模块为 python 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#ruby](lang/ruby/) | 这一模块为 ruby 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#rust](lang/rust/) | 这一模块为 rust 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#scala](lang/scala/) | 这一模块为 scala 开发提供支持，包括语法高亮，函数列表等特性 |
| [lang#sh](lang/sh/) | 这一模块为 shell script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#swift](lang/swift/) | swift language support for SpaceVim, includes code completion, syntax highlighting |
| [lang#typescript](lang/typescript/) | 这一模块为 typescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#vim](lang/vim/) | 这一模块为 vim script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lang#vue](lang/vue/) | 这一模块为 vue 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 |
| [lsp](language-server-protocol/) | lsp 模块为 SpaceVim 提供 language server protocol 的支持，提供更多语言相关服务 |
| [leaderf](leaderf/) | 提供以 leaderf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
| [shell](shell/) | 这一模块为 SpaceVim 提供了终端集成特性，优化内置终端的使用体验 |
| [sudo](sudo/) | sudo 提供了在 SpaceVim 中以管理员身份读写文件的功能。 |
| [tags](tags/) | tags 模块提供全局的 tags 索引管理，提供快速检索定义和引用的功能。 |
| [tmux](tmux/) | This layers adds extensive support for tmux |
| [tools#dash](tools/dash/) | 该模块提供对 Dash 支持，可快速查找光标位置的单词 |
| [tools](tools/) | 集成多种常用工具，包括日历、计算器、等等多种工具类插件，该模块针对 vim8 以及 neovim 提供了更好的插件选择。 |
| [ui](ui/) | SpaceVim ui 模块提供了一个 IDE-like 的界面，包括状态栏、文件树、语法数等等特性。 |
| [unite](unite/) | 提供以 unite 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 |
<!-- SpaceVim layer cn list end -->

53
docs/cn/layers/lang/agda.md Normal file
View File

@ -0,0 +1,53 @@
---
title: "SpaceVim lang#agda 模块"
description: "这一模块为 SpaceVim 提供了 agda 语言开发的支持，主要包括语法高亮及一键运行。"
lang: cn
---
# [可用模块](../../) >> lang#agda
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
Agda是一种依赖类型的函数式编程语言。这一模块为 SpaceVim 提供了 [agda](https://github.com/agda/agda) 开发支持。
## 功能特性
- 语法高亮
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#agda"
```
## 快捷键
| 按键 | 功能描述 |
| --------- | ------------------------ |
| `SPC l r` | execute current file |
| `SPC l l` | reload |
| `SPC l t` | infer |
| `SPC l f` | refine false |
| `SPC l F` | refine true |
| `SPC l g` | give |
| `SPC l c` | make case |
| `SPC l a` | auto |
| `SPC l e` | context |
| `SPC l n` | Normalize IgnoreAbstract |
| `SPC l N` | Normalize DefaultCompute |
| `SPC l M` | Show module |
| `SPC l y` | why in scope |
| `SPC l h` | helper function |
| `SPC l m` | metas |

33
docs/cn/layers/lang/autohotkey.md Normal file
View File

@ -0,0 +1,33 @@
---
title: "SpaceVim lang#autohotkey 模块"
description: "这一个模块为 SpaceVim 提供了 autohotkey 语言的开发支持，包括语法高亮和自动补全等功能。"
lang: cn
---
# [可用模块](../../) >> lang#autohotkey
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
<!-- vim-markdown-toc -->
## 模块简介
这一个模块为 SpaceVim 提供了 autohotkey 语言的开发支持。
## 功能特性
- 语法高亮
- 自动补全
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#autohotkey"
```

67
docs/cn/layers/lang/csharp.md Normal file
View File

@ -0,0 +1,67 @@
---
title: "SpaceVim lang#csharp 模块"
description: "该模块为 SpaceVim 提供 csharp 开发支持，包括代码高亮、对齐、补全等特性。"
lang: cn
---
# [Available Layers](../../) >> lang#csharp
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [依赖安装及模块启用](#依赖安装及模块启用)
- [模块启用](#模块启用)
- [安装 OmniSharp 服务](#安装-omnisharp-服务)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
该模块为 SpaceVim 提供 csharp 开发支持，包括代码高亮、对齐、补全等特性。
## 依赖安装及模块启用
### 模块启用
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#csharp"
```
### 安装 OmniSharp 服务
在使用该模块之前，需要安装 OmniSharp 服务器。启用模块后，打开 Vim 所有插件会自动下载，
当所有插件安装完毕后，进入对应的插件目录，默认是：
`$HOME/.cache/vimfiles/repos/github.com/OmniSharp/omnisharp-vim/server`
在 macOS 及 Linux 下执行：
xbuild
在 Windows 下则执行：
msbuild
或者访问插件官网，阅读 [OmniSharp 服务安装指南](https://github.com/OmniSharp/omnisharp-vim#installation)。
## 快捷键
| 按键 | 功能描述 |
| ----------- | ---------------------------------- |
| `SPC l b` | compile the project |
| `SPC l f` | format current file |
| `SPC l d` | show doc |
| `SPC l e` | rename symbol under cursor |
| `SPC l g g` | go to definition |
| `SPC l g i` | find implementations |
| `SPC l g t` | find type |
| `SPC l g s` | find symbols |
| `SPC l g u` | find usages of symbol under cursor |
| `SPC l g m` | find members in the current buffer |
| `SPC l s r` | reload the solution |
| `SPC l s s` | start the OmniSharp server |
| `SPC l s S` | stop the OmniSharp server |

39
docs/cn/layers/lang/dockerfile.md Normal file
View File

@ -0,0 +1,39 @@
---
title: "SpaceVim lang#dockerfile 模块"
description: "这一模块为 dockerfile 的编辑提供了部分功能支持，包括语法高亮和自动补全。"
lang: cn
---
# [Available Layers](../../) >> lang#dockerfile
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
<!-- vim-markdown-toc -->
## 模块简介
这一模块为 dockerfile 的编辑提供了部分功能支持，包括语法高亮和自动补全。
## 功能特性
- 语法高亮
- 语言服务器支持（需要载入 [lsp](../language-server-protocol/) 模块）
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#dockerfile"
```
若需要启用语言服务器支持，需要额外安装 dockerfile 的语言服务器 [dockerfile-language-server-nodejs](https://github.com/rcjsuen/dockerfile-language-server-nodejs)。
```sh
npm install -g dockerfile-language-server-nodejs
```

38
docs/cn/layers/lang/kotlin.md Normal file
View File

@ -0,0 +1,38 @@
---
title: "SpaceVim lang#kotlin 模块"
description: "该模块为 SpaceVim 提供了 kotlin 语言开发支持，包括语法高亮、语言服务器支持。"
lang: cn
---
# [可用模块](../../) >> lang#kotlin
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
<!-- vim-markdown-toc -->
## 模块简介
该模块为 SpaceVim 提供了 kotlin 语言开发支持。
## 功能特性
- 语法高亮
- 语言服务器支持（需要启用 [lsp](https://spacevim.org/layers/language-server-protocol/) 模块）
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#kotlin"
```
若需要启用语言服务器支持，需要额外安装 kotlin 的语言服务器 [KotlinLanguageServer](https://github.com/fwcd/KotlinLanguageServer)。

70
docs/cn/layers/lang/nim.md Normal file
View File

@ -0,0 +1,70 @@
---
title: "SpaceVim lang#nim 模块"
description: "该模块为 SpaceVim 提供 nim 开发支持，包括语法高亮、代码补全、编译运行以及交互式编程等功能。"
lang: cn
---
# [可用模块](../../) >> lang#nim
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
- [快捷键](#快捷键)
- [交互式编程](#交互式编程)
- [示例项目](#示例项目)
<!-- vim-markdown-toc -->
## 模块简介
[Nim](https://github.com/nim-lang/Nim) 是一种编译型的系统语言，具有高效的垃圾回收机制，该模块为 SpaceVim 添加了 nim 语言开发支持。
## 功能特性
- 语法高亮
- 代码补全
- 一键编译运行
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#nim"
```
在使用该模块之前，首先需要确保本地 nim 环境安装完整，可通过包管理器安装 nim， 例如：
```sh
sudo pacman -S nim nimble
```
## 快捷键
| 按键 | 功能描述 |
| --------- | ------------------------------------ |
| `SPC l r` | 编译，并运行当前文件 |
| `SPC l e` | 在当前文件范围内，重命名光标下的符号 |
| `SPC l E` | 在整个项目范围内，重命名贯标下的符号 |
### 交互式编程
启动 `nim secret` 交互进程，快捷键为： `SPC l s i`。如果存在可执行命令 `ipython`，
则使用该命令为默认的交互式命令；否则则使用默认的 `python` 命令。可通过设置虚拟环境来修改可执行命令。
将代码传输给 REPL 进程执行：
| 快捷键 | 描述 |
| ----------- | ----------------------- |
| `SPC l s b` | 发送整个文件内容至 REPL |
| `SPC l s l` | 发送当前行内容至 REPL |
| `SPC l s s` | 发送已选中的内容至 REPL |
## 示例项目
该项目为使用 SpaceVim 开发 nim 的示例项目：
<https://github.com/wsdjeg/nim-example>

41
docs/cn/layers/lang/ocaml.md Normal file
View File

@ -0,0 +1,41 @@
---
title: "SpaceVim lang#ocaml 模块"
description: "这一模块为 ocaml 开发提供了支持，包括语法高亮、代码补全、以及定义处跳转等功能。"
lang: cn
---
# [可用模块](../../) >> lang#ocaml
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
该模块为 SpaceVim 提供了 OCaml 开发支持。当项目包含多个文件时，确保项目中包含 [.merlin](https://github.com/ocaml/merlin/wiki/project-configuration) 文件。
## 功能特性
- 语法高亮
- 代码补全
- 跳转定义处
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#ocaml"
```
## 快捷键
| 按键 | 功能描述 |
| ---- | ------------------------ |
| `gd` | 跳转到光标下符号的定义处 |

40
docs/cn/layers/lang/swift.md Normal file
View File

@ -0,0 +1,40 @@
---
title: "SpaceVim lang#swift 模块"
description: "该模块主要为 SpaceVim 提供了 swift 开发支持，包括语法高亮、语法检查等特性。"
lang: cn
---
# [可用模块](../../) >> lang#swift
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
该模块主要为 SpaceVim 提供了 swift 开发支持。
## 功能特性
- 语法高亮
- 语法检查
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "lang#swift"
```
## 快捷键
| 按键 | 功能描述 |
| ----------- | ----------------------- |
| `SPC l k` | jumping to placeholders |

35
docs/cn/layers/sudo.md Normal file
View File

@ -0,0 +1,35 @@
---
title: "SpaceVim sudo 模块"
description: "sudo 提供了在 SpaceVim 中以管理员身份读写文件的功能。"
lang: cn
---
# [可用模块](../) >> sudo
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [启用模块](#启用模块)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
sudo 提供了在 SpaceVim 中以管理员身份读写文件的功能。
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "sudo"
```
## 快捷键
| 按键 | 功能描述 |
| --------- | ------------------------------------------- |
| `SPC f E` | open a file with elevated privileges (TODO) |
| `SPC f W` | save a file with elevated privileges |

52
docs/cn/layers/tmux.md Normal file
View File

@ -0,0 +1,52 @@
---
title: "SpaceVim tmux 模块"
description: "该模块主要提供了一些在 Vim 内操作 tmux 的功能，使得在 tmux 窗口之间跳转更加便捷。"
lang: cn
---
# [可用模块](../) >> tmux
<!-- vim-markdown-toc GFM -->
- [模块简介](#模块简介)
- [功能特性](#功能特性)
- [启用模块](#启用模块)
- [模块选项](#模块选项)
- [快捷键](#快捷键)
<!-- vim-markdown-toc -->
## 模块简介
该模块主要提供了一些在 Vim 内操作 tmux 的功能，使得在 tmux 窗口之间跳转更加便捷。
## 功能特性
- tmux 配置文件语法高亮
- tmux 状态栏
- 快速执行 tmux 命令
## 启用模块
可通过在配置文件内加入如下配置来启用该模块：
```toml
[[layers]]
name = "tmux"
```
## 模块选项
- `tmuxline_separators`: default value is same as SpaceVim options `statusline_separator`, available
values include: `arrow`, `curve`, `slant`, `barce`, `fire`, `nil`.
- `tmuxline_separators_alt`: default value is same as SpaceVim options `statusline_inactive_separator`
available values include: `arrow`, `bar`, `nil`.
## 快捷键
| 按键 | 功能描述 |
| -------- | ------------------------------------------ |
| `Ctrl-h` | Switch to vim/tmux pane in left direction |
| `Ctrl-j` | Switch to vim/tmux pane in down direction |
| `Ctrl-k` | Switch to vim/tmux pane in up direction |
| `Ctrl-l` | Switch to vim/tmux pane in right direction |

2
docs/documentation.md
View File

@ -130,7 +130,7 @@ Community-driven configuration provides curated packages tuned by power users an
**welcome page**
![welcome-page](https://cloud.githubusercontent.com/assets/13142418/26402270/28ad72b8-40bc-11e7-945e-003f41e057be.png)
![welcome-page](https://user-images.githubusercontent.com/13142418/45254913-e1e17580-b3b2-11e8-8983-43d6c358a474.png)
**working flow**

2
docs/index.md
View File

@ -10,7 +10,7 @@ description: "SpaceVim is a community-driven vim distribution that seeks to prov
[![Version](https://img.shields.io/badge/version-0.9.0--dev-FF69B4.svg)](https://github.com/SpaceVim/SpaceVim/releases)
[![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE)
![welcome-page](https://user-images.githubusercontent.com/13142418/37595020-273b5bca-2bb2-11e8-8aba-638ed5f1c7ea.png)
![welcome-page](https://user-images.githubusercontent.com/13142418/45254913-e1e17580-b3b2-11e8-8983-43d6c358a474.png)
# SpaceVim - Modern vim distribution

21
docs/layers/core.md Normal file
View File

@ -0,0 +1,21 @@
---
title: "SpaceVim core layer"
description: "SpaceVim core layer provides many default key bindings and features."
---
# [Available Layers](../) >> core
<!-- vim-markdown-toc GFM -->
- [Intro](#intro)
- [Features](#features)
- [Configuration](#configuration)
<!-- vim-markdown-toc -->
## Intro
## Features
## Configuration

21
docs/layers/core/banner.md Normal file
View File

@ -0,0 +1,21 @@
---
title: "SpaceVim core#banner layer"
description: "This layer provides many default banner on welcome page."
---
# [Available Layers](../) >> core#banner
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Configuration](#configuration)
<!-- vim-markdown-toc -->
## Description
This layer provides many default banner on welcome page.
## Configuration
Currently, SpaceVim do not allowed to set the frequency.

22
docs/layers/core/statusline.md Normal file
View File

@ -0,0 +1,22 @@
---
title: "SpaceVim core#statusline layer"
description: "This layer provides default statusline for SpaceVim"
---
# [Available Layers](../) >> core#statusline
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Configuration](#configuration)
<!-- vim-markdown-toc -->
## Description
This layer provides default statusline for SpaceVim.
## Configuration
All statusline key bindings can be find on [SpaceVim documentation](../../../documentation/#statusline)

17
docs/layers/core/tabline.md Normal file
View File

@ -0,0 +1,17 @@
---
title: "SpaceVim core#tabline layer"
description: "SpaceVim core#tabline layer provides a better tabline for SpaceVim"
---
# [Available Layers](../) >> core#tabline
## Intro
Different from airline, this layer provode a simple tabline for SpaceVim, which is more fast and compitable with SpaceVim's core feature.
## Key bindings
All tabline key bindings can be find on [SpaceVim documentation](../../../documentation/#tabline)

25
docs/layers/edit.md Normal file
View File

@ -0,0 +1,25 @@
---
title: "SpaceVim edit layer"
description: "Improve code edit expr in SpaceVim, provide more text opjects."
---
# [Available Layers](../) >> edit
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Features](#features)
- [Options](#options)
<!-- vim-markdown-toc -->
## Description
This layer provide many edit key bindings for SpaceVim, and also porvide more text objects.
## Features
## Options
- `textobj`: specified a list of text opjects to be enabled, the avaliable list is :`indent`, `line`, `entire`

33
docs/layers/format.md Normal file
View File

@ -0,0 +1,33 @@
---
title: "SpaceVim format layer"
description: "Code formatting support for SpaceVim"
---
# [Available Layers](../) >> format
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Install](#install)
- [Configuration](#configuration)
<!-- vim-markdown-toc -->
## Description
This layer provides code format feature SpaceVim, and neoformat is included in this layer.
## Install
This layer is enabled by default. If you want to disable this layer, add following to your configuration file:
```toml
[[layers]]
name = "tools"
enable = false
```
## Configuration
neoformat provide better default for different languages, but you can also config it in bootstrap function.

25
docs/layers/index.md
View File

@ -23,9 +23,20 @@ keeping them from having to think about what packages to install.
### Enable layers
By default only `autocomplete`, `checkers` layer are enabled. 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`
By default SpaceVim enable these layers:
- `autocomplete`
- `checkers`
- `format`
- `edit`
- `ui`
- `core`
- `core#banner`
- `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`.
here is an example for loadding `shell` layer with some specified options:
@ -58,12 +69,18 @@ enable = false
| [checkers](checkers/) | Syntax checking automatically within SpaceVim, display error on the sign column and statusline. |
| [chinese](chinese/) | Layer for chinese users, include chinese docs and runtime messages |
| [colorscheme](colorscheme/) | colorscheme provides a list of colorscheme for SpaceVim, default colorscheme is gruvbox with dark theme. |
| [core#banner](core/banner/) | "This layer provides many default banner on welcome page. |
| [core#statusline](core/statusline/) | This layer provides default statusline for SpaceVim |
| [core#tabline](core/tabline/) | SpaceVim core#tabline layer provides a better tabline for SpaceVim |
| [core](core/) | "SpaceVim core layer provides many default key bindings and features. |
| [cscope](cscope/) | cscope layer provides a smart cscope and pycscope helper for SpaceVim, help users win at cscope |
| [ctrlp](ctrlp/) | This layers provide a heavily customized ctrlp centric work-flow |
| [debug](debug/) | This layer provide debug workflow support in SpaceVim |
| [default](default/) | SpaceVim default layer contains no plugins, but It provides some better default config for SpaceVim. |
| [denite](denite/) | This layers provide a heavily customized Denite centric work-flow |
| [edit](edit/) | Improve code edit expr in SpaceVim, provide more text opjects. |
| [floobits](floobits/) | This layer adds support for the peer programming tool floobits to SpaceVim. |
| [format](format/) | Code formatting support for SpaceVim |
| [fzf](fzf/) | This layers provide a heavily customized fzf centric work-flow |
| [git](git/) | This layers adds extensive support for git |
| [github](github/) | This layer provides GitHub integration for SpaceVim |
@ -91,7 +108,7 @@ enable = false
| [lang#lua](lang/lua/) | This layer is for lua development, provide autocompletion, syntax checking, code format for lua file. |
| [lang#markdown](lang/markdown/) | Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown file. |
| [lang#nim](lang/nim/) | This layer adds nim language support to SpaceVim |
| [lang#ocaml](lang/ocaml/) | This layer is for Python development, provide autocompletion, syntax checking, code format for ocaml file. |
| [lang#ocaml](lang/ocaml/) | This layer is for ocaml development, provide autocompletion, syntax checking, code format for ocaml file. |
| [lang#perl](lang/perl/) | This layer is for perl development, provide autocompletion, syntax checking, code format for perl file. |
| [lang#php](lang/php/) | This layer adds PHP language support to SpaceVim |
| [lang#plantuml](lang/plantuml/) | This layer is for plantuml development, syntax highlighting for plantuml file. |

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

@ -16,8 +16,8 @@ description: "This layer adds agda language support to SpaceVim"
## Description
This layer adds [agda](https://github.com/agda/agda) language support to SpaceVim.
Agda is a dependently typed functional programming language.
This layer adds [agda](https://github.com/agda/agda) language support to SpaceVim.
## Features

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

@ -1,6 +1,6 @@
---
title: "SpaceVim lang#ocaml layer"
description: "This layer is for Python development, provide autocompletion, syntax checking, code format for ocaml file."
description: "This layer is for ocaml development, provide autocompletion, syntax checking, code format for ocaml file."
---
# [Available Layers](../../) >> lang#ocaml

15
docs/layers/ui.md
View File

@ -28,6 +28,17 @@ To use this configuration layer, update custom configuration file with:
## Plugins
- [mhinz/vim-startify](https://github.com/mhinz/vim-startify)
- [majutsushi/tagbar](https://github.com/majutsushi/tagbar)
- [startify](https://github.com/mhinz/vim-startify): welcome page, default key binding is `SPC a s`.
- [tagbar](https://github.com/majutsushi/tagbar): outline sidebar, default key binding is `<F2>`.
- [indentLine](https://github.com/Yggdroot/indentLine): code indent line, toggle key binding is `SPC t i`.
## Tips
SpaceVim provide default statusline and tabline plugin which are provided by `core#statusline` and `core#tabline` layer, If you want to use airline, just disable that layer:
```toml
[[layers]]
name = "core#statusline"
enable = false
```

1
wiki/en/Following-HEAD.md
View File

@ -105,6 +105,7 @@ The next release is v0.9.0.
- Add doc for `sudo` layer ([#2011](https://github.com/SpaceVim/SpaceVim/pull/2011))
- Update key notations ([#1940](https://github.com/SpaceVim/SpaceVim/pull/1940))
- Update getting help page in wiki ([#2025](https://github.com/SpaceVim/SpaceVim/pull/2025))
- Add doc for missing layers ([#2139](https://github.com/SpaceVim/SpaceVim/pull/2139))
### Others