From 4c3ca1d6be55d69f8c43f4452b93cad810f5274e Mon Sep 17 00:00:00 2001 From: wsdjeg Date: Tue, 24 Apr 2018 21:27:06 +0800 Subject: [PATCH] Hot fix --- docs/quick-start-guide.md | 46 ++++++++++++++++++++++++++++++++++----- 1 file changed, 40 insertions(+), 6 deletions(-) diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md index 0ec8552bf..3fc4db72d 100644 --- a/docs/quick-start-guide.md +++ b/docs/quick-start-guide.md @@ -3,20 +3,18 @@ title: "Quick start guide" description: "SpaceVim is a community-driven vim distribution that seeks to provide layer feature." --- - # Quick start guide -If you haven’t seen SpaceVim at all yet, the first thing you should read is The Quick start guide. +If you haven’t seen SpaceVim at all yet, the first thing you should read is this guide. It will give you a good idea of what SpaceVim is like, -show you how to install it, and explain its features. - -Upon completing the book, you’ll be an intermediate Rust developer, and will have a good grasp of the fundamental ideas behind Rust. +show you how to install it, how to config it, and explain its features. - [Install](#install) - [Linux and macOS](#linux-and-macos) - [Windows](#windows) +- [Configuration](#configuration) - [Learning SpaceVim](#learning-spacevim) @@ -46,9 +44,45 @@ curl -sLf https://spacevim.org/install.sh | bash -s -- -h The easiest way is to download [install.cmd](https://spacevim.org/install.cmd) and run it as administrator, or install SpaceVim manually. +## Configuration + +The default configuration file of SpaceVim is `~/.SpaceVim.d/init.toml`, here is an example: + +```toml +# This is basic configuration example for SpaceVim + +# 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 + colorscheme = "gruvbox" + background = "dark" + # Disable guicolors in basic mode, many terminal do not support 24bit + # true colors + 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 + filetype_icon = false + statusline_display_mode = false + +# Enable autocomplete layer +[[layers]] +name = 'autocomplete' +auto-completion-return-key-behavior = "complete" +auto-completion-tab-key-behavior = "cycle" + +[[layers]] +name = 'shell' +default_position = 'top' +default_height = 30 +``` ## Learning SpaceVim - [SpaceVim Documentation](../documentation). Also known as "The Book", The SpaceVim Documentation will introduce -you to the main topics important to using SpaceVim. The book is the primary official document of the language. + you to the main topics important to using SpaceVim. The book is the primary official document of the language. - [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim). Tell you how to hack SpaceVim.