1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-24 02:20:03 +08:00

Merge pull request #1747 from wsdjeg/doc

Update colorscheme layer doc
This commit is contained in:
Wang Shidong 2018-05-23 21:51:42 +08:00 committed by GitHub
commit 29ab11916a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 70 additions and 64 deletions

View File

@ -5,6 +5,14 @@ description: "colorscheme provides a list of colorscheme for SpaceVim, default c
# [SpaceVim Layers:](https://spacevim.org/layers) colorscheme
<!-- vim-markdown-toc GFM -->
- [Description](#description)
- [Install](#install)
- [Configuration](#configuration)
<!-- vim-markdown-toc -->
## Description
This layer provides many Vim colorschemes for SpaceVim, the default colorscheme is gruvbox.
@ -13,14 +21,20 @@ This layer provides many Vim colorschemes for SpaceVim, the default colorscheme
This layer is disabled by default in SpaceVim.
To use this configuration layer, add `call SpaceVim#layers#load('colorscheme')` to your custom configuration file.
To use this configuration layer, add this snippet to your custom configuration file.
```toml
[[layers]]
name = 'colorscheme'
```
## Configuration
To change the colorscheme:
```vim
let g:spacevim_colorscheme = 'onedark'
```toml
[options]
colorscheme = "onedark"
```
**List colorschemes**
@ -36,18 +50,18 @@ let g:spacevim_colorscheme = 'onedark'
Some colorschemes offer dark and light styles. Most of them are set by changing
Vim background color. SpaceVim support to change the background color with
`g:spacevim_colorscheme_bg`:
`colorscheme_bg`:
```vim
let g:spacevim_colorscheme_bg = 'dark'
```toml
[options]
colorscheme = "onedark"
colorscheme_bg = 'dark'
```
colorscheme layer support random colorscheme on startup. just load this layer with layer option `random-theme`
```vim
call SpaceVim#layers#load('colorscheme', {
\ 'random-theme' : 1,
\ })
```toml
[[layers]]
name = 'colorscheme'
random-theme = true
```
## Contributing

View File

@ -1,7 +1,7 @@
welcome to <img src="https://spacevim.org/SpaceVim.png" height="17" width="17"> **SpaceVim** wiki, a Resources guideline for SpaceVim!
- [Introduction](Introduction)
- **[FAQ](FAQ)**
- **[FAQ](https://spacevim.org/faq/)**
- [Progress/Roadmap](Progress)
- [Features](Features)
- [Project layout](project_layout)

View File

@ -2,7 +2,7 @@
--
[Introduction](introduction)
[Community](community)
[FAQ](FAQ)
[FAQ](https://spacevim.org/faq/)
[Layers](https://spacevim.org/layers/)
**Users**

View File

@ -1,57 +1,49 @@
### Quick start guide
SpaceVim load custom configuration from `~/.SpaceVim.d/init.vim`,
The default configuration file of SpaceVim is `~/.SpaceVim.d/init.toml`. This is
an example for basic usage of SpaceVim. For more info, please checkout SpaceVim
documentation.
:warning: It is not `~/.SpaceVim/init.vim`, user should not change anything in `~/.SpaceVim/`.
```toml
# This is basic configuration example for SpaceVim
here is an example:
# All SpaceVim option below [option] section
[options]
# set spacevim theme. by default colorscheme layer is not loaded,
# if you want to use more colorscheme, please load the colorscheme
# layer, the value of this option is a string.
colorscheme = "gruvbox"
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
# Disable statusline separator, if you want to use other value, please
# install nerd fonts
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
enable_tabline_filetype_icon = true
# Display current mode text on statusline, by default It is disabled,
# only color will be changed when switch modes.
enable_statusline_display_mode = false
```viml
" Here are some basic customizations, please refer to the ~/.SpaceVim.d/init.vim
" file for all possible options:
let g:spacevim_default_indent = 3
let g:spacevim_max_column = 80
# Enable autocomplete layer
[[layers]]
name = "autocomplete"
auto-completion-return-key-behavior = "complete"
auto-completion-tab-key-behavior = "cycle"
" Change the default directory where all miscellaneous persistent files go.
" By default it is ~/.cache/vimfiles/.
let g:spacevim_plugin_bundle_dir = '~/.cache/vimfiles/'
[[layers]]
name = "shell"
default_position = "top"
default_height = 30
" set SpaceVim colorscheme
let g:spacevim_colorscheme = 'jellybeans'
" Set plugin manager, you want to use, default is dein.vim
let g:spacevim_plugin_manager = 'dein' " neobundle or dein or vim-plug
" use space as `<Leader>`
" let mapleader = "\<space>"
" Set windows shortcut leader [Window], default is `s`
let g:spacevim_windows_leader = 's'
" Set unite work flow shortcut leader [Unite], default is `f`
let g:spacevim_unite_leader = 'f'
" By default, language specific plugins are not loaded. This can be changed
" with the following, then the plugins for go development will be loaded.
call SpaceVim#layers#load('lang#go')
" loaded ui layer
call SpaceVim#layers#load('ui')
" If there is a particular plugin you don't like, you can define this
" variable to disable them entirely:
let g:spacevim_disabled_plugins=[
\ ['junegunn/fzf.vim'],
\ ]
" If you want to add some custom plugins, use these options:
let g:spacevim_custom_plugins = [
\ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}],
\ ['wsdjeg/GitHub.vim'],
\ ]
" set the guifont
let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'
# This is an example for adding custom plugins lilydjwg/colorizer
[[custom_plugins]]
name = "lilydjwg/colorizer"
merged = 0
```
Comprehensive documentation is available for each layer by <kbd>:h SpaceVim</kbd>.