Add link of doc into README

README.md

@@ -1,5 +1,6 @@
 # SpaceVim
 [![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev)](https://travis-ci.org/SpaceVim/SpaceVim)
+[![Doc](https://img.shields.io/badge/doc-%3Ah%20github-orange.svg?style=flat-square)](doc/SpaceVim.txt)
 
 Like spacemacs, but for vim. [中文交流群：121056965, 点击加入](https://jq.qq.com/?_wv=1027&k=43DB6SG)
 

autoload/SpaceVim.vim

@@ -1,77 +1,81 @@
 scriptencoding utf-8
-function! SpaceVim#init() abort
+""
-    "Vim settings
+" @section Introduction, intro
-    let g:spacevim_                        = get(g:, 'settings', {})
+" SpaceVim is a modular configuration for vim/neovim plugins.
-    ""
+
-    " The default_indent of SpaceVim.
+""
-    let g:spacevim_default_indent          = 2
+" @section Configuration, config
-    ""
+" @plugin(name) is configured by these options.
-    " The max column of SpaceVim
+
-    let g:spacevim_max_column              = 120
+""
-    let g:spacevim_enable_googlesuggest    = 0
+" The default_indent of SpaceVim.
-    let g:spacevim_auto_download_neobundle = 0
+let g:spacevim_default_indent          = 2
-    let g:spacevim_neobundle_installed     = 0
+""
-    let g:spacevim_dein_installed          = 0
+" The max column of SpaceVim
-    let g:spacevim_vim_plug_installed      = 0
+let g:spacevim_max_column              = 120
-    let g:spacevim_plugin_bundle_dir       = $HOME. join(['', '.cache', 'vimfiles', ''], '/')
+let g:spacevim_enable_googlesuggest    = 0
-    let g:spacevim_autocomplete_method     = ''
+let g:spacevim_auto_download_neobundle = 0
-    let g:spacevim_enable_cursorcolumn     = 0
+let g:spacevim_neobundle_installed     = 0
-    let g:spacevim_enable_neomake          = 1
+let g:spacevim_dein_installed          = 0
-    ""
+let g:spacevim_vim_plug_installed      = 0
-    " set the guifont of Spacevim, default is empty.
+let g:spacevim_plugin_bundle_dir       = $HOME. join(['', '.cache', 'vimfiles', ''], '/')
-    let g:spacevim_guifont                 = ''
+let g:spacevim_autocomplete_method     = ''
-    ""
+let g:spacevim_enable_cursorcolumn     = 0
-    " Enable ycm or not, but default it is 0.
+let g:spacevim_enable_neomake          = 1
-    let g:spacevim_enable_ycm              = 0
+""
-    let g:spacevim_enable_neocomplcache    = 0
+" set the guifont of Spacevim, default is empty.
-    let g:spacevim_enable_cursorline       = 0
+let g:spacevim_guifont                 = ''
-    ""
+""
-    " The error symbol used by maker.
+" Enable ycm or not, but default it is 0.
-    let g:spacevim_error_symbol            = '✖'
+let g:spacevim_enable_ycm              = 0
-    let g:spacevim_warning_symbol          = '⚠'
+let g:spacevim_enable_neocomplcache    = 0
-    let g:spacevim_use_colorscheme         = 1
+let g:spacevim_enable_cursorline       = 0
-    let g:spacevim_vim_help_language       = 'en'
+""
-    ""
+" The error symbol used by maker.
-    " The colorscheme of SpaceVim, if colorscheme groups are installed.
+let g:spacevim_error_symbol            = '✖'
-    let g:spacevim_colorscheme             = 'gruvbox'
+let g:spacevim_warning_symbol          = '⚠'
-    ""
+let g:spacevim_use_colorscheme         = 1
-    " The default colorscheme of SpaceVim.
+let g:spacevim_vim_help_language       = 'en'
-    let g:spacevim_colorscheme_default     = 'desert'
+""
-    ""
+" The colorscheme of SpaceVim, if colorscheme groups are installed.
-    " The default file manager of SpaceVim.
+let g:spacevim_colorscheme             = 'gruvbox'
-    let g:spacevim_filemanager             = 'vimfiler'
+""
-    ""
+" The default colorscheme of SpaceVim.
-    " The default plugin manager of SpaceVim, dein, neobundle or vim-plug. by
+let g:spacevim_colorscheme_default     = 'desert'
-    " default it is dein.
+""
-    let g:spacevim_plugin_manager          = 'dein'  " neobundle or dein or vim-plug
+" The default file manager of SpaceVim.
-    let g:spacevim_checkinstall            = 0
+let g:spacevim_filemanager             = 'vimfiler'
-    let g:spacevim_hiddenfileinfo          = 1
+""
-    let g:spacevim_plugin_groups_exclude   = []
+" The default plugin manager of SpaceVim, dein, neobundle or vim-plug. by
-    ""
+" default it is dein.
-    " groups of plugins should be loaded. 
+let g:spacevim_plugin_manager          = 'dein'  " neobundle or dein or vim-plug
-    "
+let g:spacevim_checkinstall            = 0
-    " example: >
+let g:spacevim_hiddenfileinfo          = 1
-    "    let g:spacevim_plugin_groups = ['core', 'lang']
+let g:spacevim_plugin_groups_exclude   = []
-    " <
+""
-    " now Space Vim support these groups:
+" groups of plugins should be loaded. 
-    let g:spacevim_plugin_groups           = []
+"
-    ""
+" example: >
-    " enable/disable SpaceVim with powerline symbols.
+"    let g:spacevim_plugin_groups = ['core', 'lang']
-    let g:spacevim_enable_powerline_fonts  = 1
+" <
-    let g:spacevim_smartcloseignorewin     = ['__Tagbar__' , 'vimfiler:default']
+" now Space Vim support these groups:
-    let g:spacevim_smartcloseignoreft      = ['help']
+let g:spacevim_plugin_groups           = []
-    let g:spacevim_altmoveignoreft         = ['Tagbar' , 'vimfiler']
+""
-    let g:spacevim_enable_javacomplete2_py = 0
+" enable/disable SpaceVim with powerline symbols.
-    let g:spacevim_src_root                = 'E:\sources\'
+let g:spacevim_enable_powerline_fonts  = 1
-    ""
+let g:spacevim_smartcloseignorewin     = ['__Tagbar__' , 'vimfiler:default']
-    " The host file url. this option is for chinese users who can not use
+let g:spacevim_smartcloseignoreft      = ['help']
-    " google and twitter.
+let g:spacevim_altmoveignoreft         = ['Tagbar' , 'vimfiler']
-    let g:spacevim_hosts_url               = 'https://raw.githubusercontent.com/racaljk/hosts/master/hosts'
+let g:spacevim_enable_javacomplete2_py = 0
-    let g:spacevim_wildignore              = '*/tmp/*,*.so,*.swp,*.zip,*.class,tags,*.jpg,
+let g:spacevim_src_root                = 'E:\sources\'
-                \*.ttf,*.TTF,*.png,*/target/*,
+""
-                \.git,.svn,.hg,.DS_Store'
+" The host file url. this option is for chinese users who can not use
+" google and twitter.
+let g:spacevim_hosts_url               = 'https://raw.githubusercontent.com/racaljk/hosts/master/hosts'
+let g:spacevim_wildignore              = '*/tmp/*,*.so,*.swp,*.zip,*.class,tags,*.jpg,
+            \*.ttf,*.TTF,*.png,*/target/*,
+            \.git,.svn,.hg,.DS_Store'
 
-endfunction
 
 function! SpaceVim#loadCustomConfig() abort
     let custom_confs = SpaceVim#util#globpath(getcwd(), '.local.vim')
@@ -163,5 +167,5 @@ function! SpaceVim#defindFuncs() abort
 endfunction
 
 function! SpaceVim#loadPlugins() abort
-    
+
 endfunction

config/main.vim

@@ -7,7 +7,6 @@ catch
     call zvim#util#source_rc('functions.vim')
 endtry
 
-call SpaceVim#init()
 
 call zvim#util#source_rc('init.vim')
 

doc/SpaceVim.txt

@@ -3,12 +3,20 @@ wsdjeg                                                              *SpaceVim*
 
 ==============================================================================
 CONTENTS                                                   *SpaceVim-contents*
-  1. Configuration...........................................|SpaceVim-config|
+  1. Introduction.............................................|SpaceVim-intro|
-  2. Functions............................................|SpaceVim-functions|
+  2. Configuration...........................................|SpaceVim-config|
+  3. Functions............................................|SpaceVim-functions|
+
+==============================================================================
+INTRODUCTION                                                  *SpaceVim-intro*
+
+SpaceVim is a modular configuration for vim/neovim plugins.
 
 ==============================================================================
 CONFIGURATION                                                *SpaceVim-config*
 
+SpaceVim is configured by these options.
+
                                                    *g:spacevim_default_indent*
 The default_indent of SpaceVim.
 
@@ -46,6 +54,9 @@ example:
 <
 now Space Vim support these groups:
 
+                                           *g:spacevim_enable_powerline_fonts*
+enable/disable SpaceVim with powerline symbols.
+
                                                         *g:spacevim_hosts_url*
 The host file url. this option is for chinese users who can not use google and
 twitter.