diff --git a/docs/cn/quick-start-guide.md b/docs/cn/quick-start-guide.md index 58c0f3f1b7ff..c9e0b18bc13c 100644 --- a/docs/cn/quick-start-guide.md +++ b/docs/cn/quick-start-guide.md @@ -60,7 +60,7 @@ SpaceVim 的默认配置文件为 `~/.SpaceVim.d/init.toml`。下面为一简单 # 多的主题,你可以载入 colorscheme 模块 colorscheme = "gruvbox" # 背景可以取值 "dark" 和 "light" - background = "dark" + colorscheme_bg = "dark" # 启用/禁用终端真色,在目前大多数终端下都是支持真色的,当然也有 # 一小部分终端不支持真色,如果你的 SpaceVim 颜色看上去比较怪异 # 可以禁用终端真色,将下面的值设为 false diff --git a/docs/documentation.md b/docs/documentation.md index 5a2ad9658a60..07833f489276 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -273,13 +273,17 @@ SpaceVim has a minimalistic and distraction free UI: ### Colorschemes -The default colorscheme of SpaceVim is [gruvbox](https://github.com/morhetz/gruvbox). There are two variants of this colorscheme, a dark one and a light one. Some aspects of these colorscheme can be customized in the custom configuration file, read `:h gruvbox`. +The default colorscheme of SpaceVim is [gruvbox](https://github.com/morhetz/gruvbox). +There are two variants of this colorscheme, a dark one and a light one. Some aspects +of these colorscheme can be customized in the custom configuration file, read `:h gruvbox`. -It is possible to define your default themes in your `~/.SpaceVim.d/init.vim` with the variable colorschemes. For instance, to specify [vim-one with dark colorscheme](https://github.com/rakr/vim-one): +It is possible to define your default themes in your `~/.SpaceVim.d/init.toml` with +the variable colorschemes. For instance, to specify `desert`: -```vim -let g:spacevim_colorscheme = 'one' -let g:spacevim_colorscheme_bg = 'dark' +```toml +[options] + colorscheme = "desert" + colorscheme_bg = "dark" ``` | Mappings | Description | @@ -291,19 +295,29 @@ all the included colorscheme can be found in [colorscheme layer](http://spacevim **NOTE**: -SpaceVim use true colors by default, so you should make sure your terminal support true colors. for more information see: [Colours in terminal](https://gist.github.com/XVilka/8346728) +SpaceVim use true colors by default, so you should make sure your terminal support true colors. +for more information see: [Colours in terminal](https://gist.github.com/XVilka/8346728) + +If your terminal do not supports true colors, you can disable SpaceVim true colors feature +in `[options]` section: + +```toml + guicolors = false +``` ### Font -The default font used by SpaceVim is DejaVu Sans Mono for Powerline. It is recommended to install it on your system if you wish to use it. +The default font used by SpaceVim is DejaVu Sans Mono for Powerline. It is recommended +to install it on your system if you wish to use it. -To change the default font set the variable `g:spacevim_guifont` in your `~/.SpaceVim.d/init.vim` file. By default its value is: +To change the default font set the variable `guifont` in your `~/.SpaceVim.d/init.toml` file. By default its value is: -```vim -let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11' +```toml + guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11' ``` -If the specified font is not found, the fallback one will be used (depends on your system). Also note that changing this value has no effect if you are running Vim/Neovim in terminal. +If the specified font is not found, the fallback one will be used (depends on your system). +Also note that changing this value has no effect if you are running Vim/Neovim in terminal. ### UI Toggles diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md index 5dc64c09e1d7..82a1d791fcd1 100644 --- a/docs/quick-start-guide.md +++ b/docs/quick-start-guide.md @@ -59,7 +59,7 @@ documentation. # if you want to use more colorscheme, please load the colorscheme # layer, the value of this option is a string. colorscheme = "gruvbox" - background = "dark" + colorscheme_bg = "dark" # Disable guicolors in basic mode, many terminal do not support 24bit # true colors, the type of the value is boolean, true or false. guicolors = true @@ -68,11 +68,11 @@ documentation. statusline_separator = "nil" statusline_separator = "bar" buffer_index_type = 4 - # Display file type icon on the tabline, If you do not have nerd fonts installed, - # please change the value to false + # Display file type icon on the tabline, If you do not have nerd fonts + # installed, please change the value to false enable_tabline_filetype_icon = true - # Display current mode text on statusline, by default It is disabled, only color - # will be changed when switch modes. + # Display current mode text on statusline, by default It is disabled, + # only color will be changed when switch modes. statusline_display_mode = false # Enable autocomplete layer