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

Update doc

This commit is contained in:
wsdjeg 2017-01-11 01:03:52 +08:00
parent 2f738623d7
commit db9b36e37b
3 changed files with 39 additions and 18 deletions

View File

@ -1,16 +1,12 @@
scriptencoding utf-8
"" ""
" @section Introduction, intro " @section Introduction, intro
" @stylized Maktaba
" @library " @library
" SpaceVim is a modular configuration for vim/neovim plugins.
" @order intro version dicts functions exceptions layers " @order intro version dicts functions exceptions layers
""
" @section Configuration, config
" @plugin(name) is configured by these options.
"" ""
" Version of SpaceVim , this value can not be changed. " Version of SpaceVim , this value can not be changed.
scriptencoding utf-8
let g:spacevim_version = '0.1.0-dev' let g:spacevim_version = '0.1.0-dev'
lockvar g:spacevim_version lockvar g:spacevim_version
"" ""
@ -38,7 +34,6 @@ let g:spacevim_enable_guicolors = 1
" let g:spacevim_enable_googlesuggest = 1 " let g:spacevim_enable_googlesuggest = 1
" < " <
let g:spacevim_enable_googlesuggest = 0 let g:spacevim_enable_googlesuggest = 0
let g:spacevim_auto_download_neobundle = 0
let g:spacevim_neobundle_installed = 0 let g:spacevim_neobundle_installed = 0
let g:spacevim_dein_installed = 0 let g:spacevim_dein_installed = 0
let g:spacevim_vim_plug_installed = 0 let g:spacevim_vim_plug_installed = 0
@ -54,11 +49,22 @@ let g:spacevim_enable_cursorcolumn = 0
let g:spacevim_enable_neomake = 1 let g:spacevim_enable_neomake = 1
"" ""
" set the guifont of Spacevim, default is empty. " set the guifont of Spacevim, default is empty.
" >
" let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'
" <
let g:spacevim_guifont = '' let g:spacevim_guifont = ''
"" ""
" Enable ycm or not, but default it is 0. " Enable ycm or not, but default it is 0.
" >
" let g:spacevim_enable_ycm = 1
" <
let g:spacevim_enable_ycm = 0 let g:spacevim_enable_ycm = 0
let g:spacevim_enable_neocomplcache = 0 let g:spacevim_enable_neocomplcache = 0
""
" Enable cursorline
" >
" let g:spacevim_enable_cursorline = 1
" <
let g:spacevim_enable_cursorline = 0 let g:spacevim_enable_cursorline = 0
"" ""
" The error symbol used by maker. " The error symbol used by maker.
@ -98,6 +104,8 @@ let g:spacevim_enable_debug = 0
let g:spacevim_debug_level = 1 let g:spacevim_debug_level = 1
let g:spacevim_hiddenfileinfo = 1 let g:spacevim_hiddenfileinfo = 1
let g:spacevim_plugin_groups_exclude = [] let g:spacevim_plugin_groups_exclude = []
"" ""
" groups of plugins should be loaded. " groups of plugins should be loaded.
" "
@ -184,6 +192,11 @@ function! SpaceVim#loadCustomConfig() abort
endif endif
endfunction endfunction
""
" @section Layers, layers
" SpaceVim support such layers:
"" ""
" Load the {layer} you want : " Load the {layer} you want :
" autocompletion : Make SpaceVim support autocompletion. " autocompletion : Make SpaceVim support autocompletion.

View File

@ -1,7 +1,4 @@
scriptencoding utf-8 scriptencoding utf-8
""
" @section Layers layers
" nihao
let s:plugins = {} let s:plugins = {}
let s:plugins.core = [ let s:plugins.core = [

View File

@ -1,25 +1,19 @@
*SpaceVim.txt* Like spacemacs, but for vim *SpaceVim.txt* Like spacemacs, but for vim
wsdjeg *SpaceVim* wsdjeg *Maktaba* *SpaceVim*
============================================================================== ==============================================================================
CONTENTS *SpaceVim-contents* CONTENTS *SpaceVim-contents*
1. Introduction.............................................|SpaceVim-intro| 1. Introduction.............................................|SpaceVim-intro|
2. Configuration...........................................|SpaceVim-config| 2. Configuration...........................................|SpaceVim-config|
3. Functions............................................|SpaceVim-functions| 3. Functions............................................|SpaceVim-functions|
4. Layers..................................................|SpaceVim-layers|
============================================================================== ==============================================================================
INTRODUCTION *SpaceVim-intro* INTRODUCTION *SpaceVim-intro*
SpaceVim is a modular configuration for vim/neovim plugins.
============================================================================== ==============================================================================
CONFIGURATION *SpaceVim-config* CONFIGURATION *SpaceVim-config*
SpaceVim is configured by these options.
*g:spacevim_version*
Version of SpaceVim , this value can not be changed.
*g:spacevim_default_indent* *g:spacevim_default_indent*
Change the default indent of SpaceVim. default is 2. Change the default indent of SpaceVim. default is 2.
> >
@ -54,9 +48,21 @@ set it by:
*g:spacevim_guifont* *g:spacevim_guifont*
set the guifont of Spacevim, default is empty. set the guifont of Spacevim, default is empty.
>
let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'
<
*g:spacevim_enable_ycm* *g:spacevim_enable_ycm*
Enable ycm or not, but default it is 0. Enable ycm or not, but default it is 0.
>
let g:spacevim_enable_ycm = 1
<
*g:spacevim_enable_cursorline*
Enable cursorline
>
let g:spacevim_enable_cursorline = 1
<
*g:spacevim_error_symbol* *g:spacevim_error_symbol*
The error symbol used by maker. The error symbol used by maker.
@ -159,5 +165,10 @@ SpaceVim#logger#setOutput({file}) *SpaceVim#logger#setOutput()*
Set log output file of SpaceVim. by default it is Set log output file of SpaceVim. by default it is
`~/.SpaceVim/.SpaceVim.log` `~/.SpaceVim/.SpaceVim.log`
==============================================================================
LAYERS *SpaceVim-layers*
SpaceVim support such layers:
vim:tw=78:ts=8:ft=help:norl: vim:tw=78:ts=8:ft=help:norl: