Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix doc for colorscheme_bg && close #1737 #1739

Merged
merged 1 commit into from May 22, 2018
Merged

Fix doc for colorscheme_bg && close #1737 #1739

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/cn/quick-start-guide.md
View file
Open in desktop
Expand Up @@ -60,7 +60,7 @@ SpaceVim 的默认配置文件为 `~/.SpaceVim.d/init.toml`。下面为一简单
# 多的主题，你可以载入 colorscheme 模块
colorscheme = "gruvbox"
# 背景可以取值 "dark" 和 "light"
background = "dark"
colorscheme_bg = "dark"
# 启用/禁用终端真色，在目前大多数终端下都是支持真色的，当然也有
# 一小部分终端不支持真色，如果你的 SpaceVim 颜色看上去比较怪异
# 可以禁用终端真色，将下面的值设为 false
Expand Down
36 changes: 25 additions & 11 deletions docs/documentation.md
View file
Open in desktop
Expand Up @@ -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 |
Expand All @@ -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

Expand Down
10 changes: 5 additions & 5 deletions docs/quick-start-guide.md
View file
Open in desktop
Expand Up @@ -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
Expand All @@ -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
Expand Down