Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-02-03 00:20:05 +08:00
Code Issues Projects Releases Wiki Activity

Update doc (#2849)

Browse Source 
* Update doc

* Update doc

* Update doc

* Update doc
This commit is contained in:
Wang Shidong 2019-05-30 21:14:39 +08:00 committed by GitHub
parent d46e4a5b86
commit 5f0dfcb2f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 451 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

206
autoload/SpaceVim.vim
View File

@ -209,6 +209,16 @@ let g:spacevim_plugin_bundle_dir
" let g:spacevim_realtime_leader_guide = 0
" <
let g:spacevim_realtime_leader_guide = 1
""
" @section enable_key_frequency, options-enable_key_frequency
" @parentsection options
" Enable/Disable key frequency catching of SpaceVim. default value is 0. to
" enable it:
" >
" enable_key_frequency = true
" <
""
" Enable/Disable key frequency catching of SpaceVim. default value is 0. to
" enable it:
@ -218,6 +228,27 @@ let g:spacevim_realtime_leader_guide = 1
let g:spacevim_enable_key_frequency = 0
if (has('python3') && SpaceVim#util#haspy3lib('neovim')) &&
\ (has('nvim') || (has('patch-8.0.0027')))
""
" @section autocomplete_method, options-autocomplete_method
" @parentsection options
" Set the autocomplete engine of spacevim, the default logic is:
" >
" if has('python3')
" let g:spacevim_autocomplete_method = 'deoplete'
" elseif has('lua')
" let g:spacevim_autocomplete_method = 'neocomplete'
" elseif has('python')
" let g:spacevim_autocomplete_method = 'completor'
" elseif has('timers')
" let g:spacevim_autocomplete_method = 'asyncomplete'
" else
" let g:spacevim_autocomplete_method = 'neocomplcache'
" endif
" <
"
" and you can alse set this option to coc, then coc.nvim will be used.
""
" Set the autocomplete engine of spacevim, the default logic is:
" >
@ -334,6 +365,16 @@ let g:spacevim_sidebar_width = 30
" <
let g:spacevim_snippet_engine = 'neosnippet'
let g:spacevim_enable_neocomplcache = 0
""
" @section enable_cursorline, options-enable_cursorline
" @parentsection options
" Enable/Disable cursorline. Default is true, cursorline will be
" highlighted in normal mode.To disable this feature:
" >
" enable_cursorline = false
" <
""
" Enable/Disable cursorline. Default is 1, cursorline will be
" highlighted in normal mode.To disable this feature:
@ -341,6 +382,22 @@ let g:spacevim_enable_neocomplcache = 0
" let g:spacevim_enable_cursorline = 0
" <
let g:spacevim_enable_cursorline = 1
""
" @section statusline_separator, options-statusline_separator
" @parentsection options
" Set the statusline separators of statusline, default is 'arrow'
" >
" Separators options:
" 1. arrow
" 2. curve
" 3. slant
" 4. nil
" 5. fire
" <
"
" See more details in: http://spacevim.org/documentation/#statusline
"
""
" Set the statusline separators of statusline, default is 'arrow'
" >
@ -355,10 +412,54 @@ let g:spacevim_enable_cursorline = 1
" See more details in: http://spacevim.org/documentation/#statusline
"
let g:spacevim_statusline_separator = 'arrow'
let g:spacevim_statusline_inactive_separator = 'arrow'
""
" @section statusline_iseparator, options-statusline_iseparator
" @parentsection options
" Set the statusline separators of statusline in inactive windows, default is
" 'arrow'
" >
" Separators options:
" 1. arrow
" 2. curve
" 3. slant
" 4. nil
" 5. fire
" <
"
" See more details in: http://spacevim.org/documentation/#statusline
"
""
" Enable/Disable showing full path of current buffer on statusline
" Set the statusline separators of statusline in inactive windows, default is
" 'arrow'
" >
" Separators options:
" 1. arrow
" 2. curve
" 3. slant
" 4. nil
" 5. fire
" <
"
" See more details in: http://spacevim.org/documentation/#statusline
"
let g:spacevim_statusline_iseparator = 'arrow'
""
" @section enable_statusline_bfpath, options-enable_statusline_bfpath
" @parentsection options
" Enable/Disable showing full path of current buffer on statusline, disabled
" by default, to enable this feature:
" >
" enable_statusline_bfpath = true
" <
""
" Enable/Disable showing full path of current buffer on statusline, disabled
" by default, to enable this feature:
" >
" enable_statusline_bfpath = true
" <
let g:spacevim_enable_statusline_bfpath = 0
""
@ -372,6 +473,19 @@ let g:spacevim_enable_statusline_bfpath = 0
""
" Enable/Disable showing current tag on statusline
let g:spacevim_enable_statusline_tag = 1
""
" @section statusline_left_sections, options-statusline_left_sections
" @parentsection options
" Define the left section of statusline in active windows. By default:
" >
" statusline_left_sections = [
" 'winnr',
" 'filename',
" 'major mode',
" 'minor mode lighters',
" 'version control info'
" ]
" <
""
" Define the left section of statusline in active windows. By default:
@ -463,18 +577,53 @@ let g:spacevim_enable_cursorcolumn = 0
" let g:spacevim_error_symbol = '+'
" <
let g:spacevim_error_symbol = '✖'
""
" @section warning_symbol, options-warning_symbol
" @parentsection options
" Set the warning symbol for SpaceVim's syntax maker. Default is '⚠'.
" >
" warning_symbol = '!'
" <
""
" Set the warning symbol for SpaceVim's syntax maker. Default is '⚠'.
" >
" let g:spacevim_warning_symbol = '!'
" <
let g:spacevim_warning_symbol = '⚠'
""
" @section info_symbol, options-info_symbol
" @parentsection options
" Set the information symbol for SpaceVim's syntax maker. Default is '🛈'.
" >
" info_symbol = 'i'
" <
""
" Set the information symbol for SpaceVim's syntax maker. Default is '🛈'.
" >
" let g:spacevim_info_symbol = 'i'
" <
let g:spacevim_info_symbol = SpaceVim#api#import('messletters').circled_letter('i')
""
" @section terminal_cursor_shape, options-terminal_cursor_shape
" @parentsection options
" Set the SpaceVim cursor shape in the terminal.
" >
" 0 : to prevent Nvim from changing the cursor shape.
" 1 : to enable non-blinking mode-sensitive cursor.
" 2 : to enable blinking mode-sensitive cursor (default).
" >
" Host terminal must support the DECSCUSR CSI escape sequence.
" Depending on the terminal emulator, using this option with nvim under
" tmux might require adding the following to ~/.tmux.conf:
" >
" set -ga terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q'
" <
""
" Set the SpaceVim cursor shape in the terminal.
" >
@ -496,18 +645,41 @@ let g:spacevim_terminal_cursor_shape = 2
" let g:spacevim_vim_help_language = 'cn'
" <
let g:spacevim_vim_help_language = 'en'
""
" @section language, options-language
" @parentsection options
" Set the message language of vim. Default is 'en_US.UTF-8'.
" >
" language = 'en_CA.utf8'
" <
""
" Set the message language of vim. Default is 'en_US.UTF-8'.
" >
" let g:spacevim_language = 'en_CA.utf8'
" <
let g:spacevim_language = ''
""
" @section keep_server_alive, options-keep_server_alive
" @parentsection options
" Option for keep the spacevim server ailive
""
" Option for keep the spacevim server ailive
let g:spacevim_keep_server_alive = 1
""
" @section colorscheme, options-colorscheme
" @parentsection options
" The colorscheme of SpaceVim. Default is 'gruvbox'.
""
" The colorscheme of SpaceVim. Default is 'gruvbox'.
let g:spacevim_colorscheme = 'gruvbox'
""
" @section colorscheme_bg, options-colorscheme_bg
" @parentsection options
" The background of colorscheme. Default is 'dark'.
""
" The background of colorscheme. Default is 'dark'.
let g:spacevim_colorscheme_bg = 'dark'
@ -519,6 +691,15 @@ let g:spacevim_colorscheme_bg = 'dark'
" let g:spacevim_colorscheme_default = 'other_color'
" <
let g:spacevim_colorscheme_default = 'desert'
""
" @section simple_mode, options-simple_mode
" @parentsection options
" Enable/disable simple mode of SpaceVim. Default is false.
" In this mode, only few plugins will be installed.
" >
" simple_mode = true
" <
""
" Enable/disable simple mode of SpaceVim. Default is 0.
" In this mode, only few plugins will be installed.
@ -526,10 +707,23 @@ let g:spacevim_colorscheme_default = 'desert'
" let g:spacevim_simple_mode = 1
" <
let g:spacevim_simple_mode = 0
""
" @section filemanager, options-filemanager
" @parentsection options
" The default file manager of SpaceVim. Default is 'vimfiler'.
" you can also use nerdtree or defx
""
" The default file manager of SpaceVim. Default is 'vimfiler'.
" you can also use nerdtree or defx
let g:spacevim_filemanager = 'vimfiler'
""
" @section filetree_direction, options-filetree_direction
" @parentsection options
" Config the direction of file tree. Default is 'right'. you can also set to
" 'left'.
"
" NOTE: if it is 'left', the tagbar will be move to right.
""
" Config the direction of file tree. Default is 'right'. you can also set to
@ -583,6 +777,14 @@ let g:spacevim_checkinstall = 1
" <C-x> switch buffer
" <
let g:spacevim_vimcompatible = 0
""
" @section enable_debug, options-enable_debug
" @parentsection options
" Enable/Disable debug mode for SpaceVim. Default is false.
" >
" enable_debug = true
" <
""
" Enable/Disable debug mode for SpaceVim. Default is 0.
" >

2
autoload/SpaceVim/layers/core/statusline.vim
View File

@ -83,7 +83,7 @@ let s:loaded_sections_r = g:spacevim_statusline_right_sections
let s:loaded_sections_l = g:spacevim_statusline_left_sections
let [s:lsep , s:rsep] = get(s:separators, g:spacevim_statusline_separator, s:separators['arrow'])
let [s:ilsep , s:irsep] = get(s:i_separators, g:spacevim_statusline_inactive_separator, s:i_separators['arrow'])
let [s:ilsep , s:irsep] = get(s:i_separators, g:spacevim_statusline_iseparator, s:i_separators['arrow'])
if SpaceVim#layers#isLoaded('checkers')
call add(s:loaded_modes, 'syntax-checking')

2
autoload/SpaceVim/layers/core/tabline.vim
View File

@ -219,7 +219,7 @@ function! SpaceVim#layers#core#tabline#get() abort
endfunction
function! SpaceVim#layers#core#tabline#config() abort
let [s:lsep , s:rsep] = get(s:separators, g:spacevim_statusline_separator, s:separators['arrow'])
let [s:ilsep , s:irsep] = get(s:i_separators, g:spacevim_statusline_inactive_separator, s:separators['arrow'])
let [s:ilsep , s:irsep] = get(s:i_separators, g:spacevim_statusline_iseparator, s:separators['arrow'])
set tabline=%!SpaceVim#layers#core#tabline#get()
augroup SpaceVim_tabline
autocmd!

270
doc/SpaceVim.txt
View File

@ -18,30 +18,48 @@ wsdjeg *spacevim* *SpaceVim*
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_bepo_layout..............|SpaceVim-options-enable_bepo_layout|
5. enable_googlesuggest..........|SpaceVim-options-enable_googlesuggest|
6. enable_guicolors..................|SpaceVim-options-enable_guicolors|
7. enable_insert_leader..........|SpaceVim-options-enable_insert_leader|
8. enable_neomake......................|SpaceVim-options-enable_neomake|
9. enable_statusline_mode......|SpaceVim-options-enable_statusline_mode|
10. enable_statusline_tag.......|SpaceVim-options-enable_statusline_tag|
11. enable_ycm.............................|SpaceVim-options-enable_ycm|
12. error_symbol.........................|SpaceVim-options-error_symbol|
13. guifont...................................|SpaceVim-options-guifont|
14. home_files_number...............|SpaceVim-options-home_files_number|
15. lint_on_the_fly...................|SpaceVim-options-lint_on_the_fly|
16. max_column.............................|SpaceVim-options-max_column|
17. plugin_bundle_dir...............|SpaceVim-options-plugin_bundle_dir|
18. plugin_manager_processes.|SpaceVim-options-plugin_manager_processes|
19. realtime_leader_guide.......|SpaceVim-options-realtime_leader_guide|
20. relativenumber.....................|SpaceVim-options-relativenumber|
21. retry_cnt...............................|SpaceVim-options-retry_cnt|
22. sidebar_width.......................|SpaceVim-options-sidebar_width|
23. snippet_engine.....................|SpaceVim-options-snippet_engine|
24. windows_leader.....................|SpaceVim-options-windows_leader|
1. autocomplete_method............|SpaceVim-options-autocomplete_method|
2. checkinstall..........................|SpaceVim-options-checkinstall|
3. colorscheme............................|SpaceVim-options-colorscheme|
4. colorscheme_bg......................|SpaceVim-options-colorscheme_bg|
5. default_indent......................|SpaceVim-options-default_indent|
6. enable_ale..............................|SpaceVim-options-enable_ale|
7. enable_bepo_layout..............|SpaceVim-options-enable_bepo_layout|
8. enable_cursorline................|SpaceVim-options-enable_cursorline|
9. enable_debug..........................|SpaceVim-options-enable_debug|
10. enable_googlesuggest.........|SpaceVim-options-enable_googlesuggest|
11. enable_guicolors.................|SpaceVim-options-enable_guicolors|
12. enable_insert_leader.........|SpaceVim-options-enable_insert_leader|
13. enable_key_frequency.........|SpaceVim-options-enable_key_frequency|
14. enable_neomake.....................|SpaceVim-options-enable_neomake|
15. enable_statusline_bfpath.|SpaceVim-options-enable_statusline_bfpath|
16. enable_statusline_mode.....|SpaceVim-options-enable_statusline_mode|
17. enable_statusline_tag.......|SpaceVim-options-enable_statusline_tag|
18. enable_ycm.............................|SpaceVim-options-enable_ycm|
19. error_symbol.........................|SpaceVim-options-error_symbol|
20. filemanager...........................|SpaceVim-options-filemanager|
21. filetree_direction.............|SpaceVim-options-filetree_direction|
22. guifont...................................|SpaceVim-options-guifont|
23. home_files_number...............|SpaceVim-options-home_files_number|
24. info_symbol...........................|SpaceVim-options-info_symbol|
25. keep_server_alive...............|SpaceVim-options-keep_server_alive|
26. language.................................|SpaceVim-options-language|
27. lint_on_the_fly...................|SpaceVim-options-lint_on_the_fly|
28. max_column.............................|SpaceVim-options-max_column|
29. plugin_bundle_dir...............|SpaceVim-options-plugin_bundle_dir|
30. plugin_manager_processes.|SpaceVim-options-plugin_manager_processes|
31. realtime_leader_guide.......|SpaceVim-options-realtime_leader_guide|
32. relativenumber.....................|SpaceVim-options-relativenumber|
33. retry_cnt...............................|SpaceVim-options-retry_cnt|
34. sidebar_width.......................|SpaceVim-options-sidebar_width|
35. simple_mode...........................|SpaceVim-options-simple_mode|
36. snippet_engine.....................|SpaceVim-options-snippet_engine|
37. statusline_iseparator.......|SpaceVim-options-statusline_iseparator|
38. statusline_left_sections.|SpaceVim-options-statusline_left_sections|
39. statusline_separator.........|SpaceVim-options-statusline_separator|
40. terminal_cursor_shape.......|SpaceVim-options-terminal_cursor_shape|
41. warning_symbol.....................|SpaceVim-options-warning_symbol|
42. windows_leader.....................|SpaceVim-options-windows_leader|
3. Configuration...........................................|SpaceVim-config|
4. Commands..............................................|SpaceVim-commands|
5. Functions............................................|SpaceVim-functions|
@ -123,6 +141,26 @@ here is an example setting SpaceVim options:
max-column = 120
<
==============================================================================
AUTOCOMPLETE_METHOD *SpaceVim-options-autocomplete_method*
Set the autocomplete engine of spacevim, the default logic is:
>
if has('python3')
let g:spacevim_autocomplete_method = 'deoplete'
elseif has('lua')
let g:spacevim_autocomplete_method = 'neocomplete'
elseif has('python')
let g:spacevim_autocomplete_method = 'completor'
elseif has('timers')
let g:spacevim_autocomplete_method = 'asyncomplete'
else
let g:spacevim_autocomplete_method = 'neocomplcache'
endif
<
and you can alse set this option to coc, then coc.nvim will be used.
==============================================================================
CHECKINSTALL *SpaceVim-options-checkinstall*
@ -131,6 +169,16 @@ Enable/Disable checkinstall on SpaceVim startup. Default is true.
checkinstall = true
<
==============================================================================
COLORSCHEME *SpaceVim-options-colorscheme*
The colorscheme of SpaceVim. Default is 'gruvbox'.
==============================================================================
COLORSCHEME_BG *SpaceVim-options-colorscheme_bg*
The background of colorscheme. Default is 'dark'.
==============================================================================
DEFAULT_INDENT *SpaceVim-options-default_indent*
@ -155,6 +203,23 @@ Enable/Disable bepo layout, by default it is disabled.
enable_bepo_layout = true
<
==============================================================================
ENABLE_CURSORLINE *SpaceVim-options-enable_cursorline*
Enable/Disable cursorline. Default is true, cursorline will be highlighted in
normal mode.To disable this feature:
>
enable_cursorline = false
<
==============================================================================
ENABLE_DEBUG *SpaceVim-options-enable_debug*
Enable/Disable debug mode for SpaceVim. Default is false.
>
enable_debug = true
<
==============================================================================
ENABLE_GOOGLESUGGEST *SpaceVim-options-enable_googlesuggest*
@ -176,6 +241,15 @@ ENABLE_INSERT_LEADER *SpaceVim-options-enable_insert_leader*
Enable/Disable spacevim's insert mode leader, default is enable
==============================================================================
ENABLE_KEY_FREQUENCY *SpaceVim-options-enable_key_frequency*
Enable/Disable key frequency catching of SpaceVim. default value is 0. to
enable it:
>
enable_key_frequency = true
<
==============================================================================
ENABLE_NEOMAKE *SpaceVim-options-enable_neomake*
@ -184,6 +258,15 @@ SpaceVim default checker is neomake. If you want to use syntastic, use:
enable_neomake = false
<
==============================================================================
ENABLE_STATUSLINE_BFPATH *SpaceVim-options-enable_statusline_bfpath*
Enable/Disable showing full path of current buffer on statusline, disabled by
default, to enable this feature:
>
enable_statusline_bfpath = true
<
==============================================================================
ENABLE_STATUSLINE_MODE *SpaceVim-options-enable_statusline_mode*
@ -217,6 +300,20 @@ Set the error symbol for SpaceVim's syntax maker. Default is '✖'.
error_symbol = "+"
<
==============================================================================
FILEMANAGER *SpaceVim-options-filemanager*
The default file manager of SpaceVim. Default is 'vimfiler'. you can also use
nerdtree or defx
==============================================================================
FILETREE_DIRECTION *SpaceVim-options-filetree_direction*
Config the direction of file tree. Default is 'right'. you can also set to
'left'.
NOTE: if it is 'left', the tagbar will be move to right.
==============================================================================
GUIFONT *SpaceVim-options-guifont*
@ -233,6 +330,27 @@ Change the list number of files for SpaceVim home. Default is 6.
home_files_number = 6
<
==============================================================================
INFO_SYMBOL *SpaceVim-options-info_symbol*
Set the information symbol for SpaceVim's syntax maker. Default is '🛈'.
>
info_symbol = 'i'
<
==============================================================================
KEEP_SERVER_ALIVE *SpaceVim-options-keep_server_alive*
Option for keep the spacevim server ailive
==============================================================================
LANGUAGE *SpaceVim-options-language*
Set the message language of vim. Default is 'en_US.UTF-8'.
>
language = 'en_CA.utf8'
<
==============================================================================
LINT_ON_THE_FLY *SpaceVim-options-lint_on_the_fly*
@ -293,6 +411,15 @@ 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.
==============================================================================
SIMPLE_MODE *SpaceVim-options-simple_mode*
Enable/disable simple mode of SpaceVim. Default is false. In this mode, only
few plugins will be installed.
>
simple_mode = true
<
==============================================================================
SNIPPET_ENGINE *SpaceVim-options-snippet_engine*
@ -302,6 +429,80 @@ ultisnips:
snippet_engine = "ultisnips"
<
==============================================================================
STATUSLINE_ISEPARATOR *SpaceVim-options-statusline_iseparator*
Set the statusline separators of statusline in inactive windows, default is
'arrow'
>
Separators options:
1. arrow
2. curve
3. slant
4. nil
5. fire
<
See more details in: http://spacevim.org/documentation/#statusline
==============================================================================
STATUSLINE_LEFT_SECTIONS *SpaceVim-options-statusline_left_sections*
Define the left section of statusline in active windows. By default:
>
statusline_left_sections = [
'winnr',
'filename',
'major mode',
'minor mode lighters',
'version control info'
]
<
==============================================================================
STATUSLINE_SEPARATOR *SpaceVim-options-statusline_separator*
Set the statusline separators of statusline, default is 'arrow'
>
Separators options:
1. arrow
2. curve
3. slant
4. nil
5. fire
<
See more details in: http://spacevim.org/documentation/#statusline
==============================================================================
TERMINAL_CURSOR_SHAPE *SpaceVim-options-terminal_cursor_shape*
Set the SpaceVim cursor shape in the terminal.
>
0 : to prevent Nvim from changing the cursor shape.
1 : to enable non-blinking mode-sensitive cursor.
2 : to enable blinking mode-sensitive cursor (default).
<
>
<
Host terminal must support the DECSCUSR CSI escape sequence. Depending on the
terminal emulator, using this option with nvim under tmux might require adding
the following to ~/.tmux.conf:
>
set -ga terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q'
<
==============================================================================
WARNING_SYMBOL *SpaceVim-options-warning_symbol*
Set the warning symbol for SpaceVim's syntax maker. Default is '⚠'.
>
warning_symbol = '!'
<
==============================================================================
WINDOWS_LEADER *SpaceVim-options-windows_leader*
@ -460,11 +661,30 @@ Set the statusline separators of statusline, default is 'arrow'
5. fire
<
See more details in: http://spacevim.org/documentation/#statusline
*g:spacevim_statusline_iseparator*
Set the statusline separators of statusline in inactive windows, default is
'arrow'
>
Separators options:
1. arrow
2. curve
3. slant
4. nil
5. fire
<
See more details in: http://spacevim.org/documentation/#statusline
*g:spacevim_enable_statusline_bfpath*
Enable/Disable showing full path of current buffer on statusline
Enable/Disable showing full path of current buffer on statusline, disabled by
default, to enable this feature:
>
enable_statusline_bfpath = true
<
*g:spacevim_enable_statusline_tag*
Enable/Disable showing current tag on statusline