From fbc6bd0541bf1e019c320d291ba5f6e37f461984 Mon Sep 17 00:00:00 2001 From: wsdjeg Date: Fri, 18 May 2018 20:46:01 +0800 Subject: [PATCH] Fix quick guide --- docs/cn/quick-start-guide.md | 51 ++++++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 20 deletions(-) diff --git a/docs/cn/quick-start-guide.md b/docs/cn/quick-start-guide.md index 005cca011..58c0f3f1b 100644 --- a/docs/cn/quick-start-guide.md +++ b/docs/cn/quick-start-guide.md @@ -7,8 +7,8 @@ lang: cn # SpaceVim 入门指南 -如果你从未使用过 SpaceVim,建议先阅读这篇简短的教程。这篇教程主要讲述:什么是 SpaceVim, -如何安装 SpaceVim,SpaceVim 的入门配置以及基本特性 +如果你从未使用过 SpaceVim,建议先阅读这篇简短的教程。这篇教程主要讲述: +如何安装 SpaceVim,SpaceVim 的入门配置以及 SpaceVim 常用学习资源。 @@ -52,42 +52,53 @@ SpaceVim 的默认配置文件为 `~/.SpaceVim.d/init.toml`。下面为一简单 ```toml -# This is basic configuration example for SpaceVim +# 这是一个基础的 SpaceVim 配置示例 -# All SpaceVim option below [option] section +# 所有的 SpaceVim 选项都列在 [option] 之下 [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. + # 设置 SpaceVim 主题及背景,默认的主题是 gruvbox,如果你需要使用更 + # 多的主题,你可以载入 colorscheme 模块 colorscheme = "gruvbox" + # 背景可以取值 "dark" 和 "light" background = "dark" - # Disable guicolors in basic mode, many terminal do not support 24bit - # true colors, the type of the value is boolean, true or false. + # 启用/禁用终端真色,在目前大多数终端下都是支持真色的,当然也有 + # 一小部分终端不支持真色,如果你的 SpaceVim 颜色看上去比较怪异 + # 可以禁用终端真色,将下面的值设为 false guicolors = true - # Disable statusline separator, if you want to use other value, please - # install nerd fonts + # 设置状态栏上分割符号形状,如果字体安装失败,可以将值设为 "nil" 以 + # 禁用分割符号,默认为箭头 "arrow" statusline_separator = "nil" statusline_separator = "bar" + # 设置顶部标签列表序号类型,有以下五种类型,分别是 0 - 4 + # 0: 1 ➛ ➊ + # 1: 1 ➛ ➀ + # 2: 1 ➛ ⓵ + # 3: 1 ➛ ¹ + # 4: 1 ➛ 1 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 + # 显示/隐藏顶部标签栏上文件类型图标,这一图标需要安装 nerd fonts, + # 如果未能成功安装这一字体,可以隐藏图标 enable_tabline_filetype_icon = true - # Display current mode text on statusline, by default It is disabled, only color - # will be changed when switch modes. + # 是否在状态栏上显示当前模式,默认情况下,不显示 Normal/Insert 等 + # 字样,只以颜色区分当前模式 statusline_display_mode = false -# Enable autocomplete layer +# SpaceVim 模块设置,主要包括启用/禁用模块 + +# 启用 autocomplete 模块, 启用模块时,可以列出一些模块选项,并赋值, +# 关于模块的选项,请阅读各个模块的文档 [[layers]] name = "autocomplete" auto-completion-return-key-behavior = "complete" auto-completion-tab-key-behavior = "cycle" +# 禁用 shell 模块, 禁用模块时,需要加入 enable = false [[layers]] name = "shell" -default_position = "top" -default_height = 30 +enable = false + +# 添加自定义插件 -# This is an example for adding custom plugins lilydjwg/colorizer [[custom_plugins]] name = "lilydjwg/colorizer" merged = 0 @@ -95,6 +106,6 @@ merged = 0 ## 学习SpaceVim -- [SpaceVim 用户文档](../documentation). SpaceVim 官方文档,包含了 SpaceVim 配置及使用的每一个细节,是熟悉和掌握 SpaceVim 使用技巧的必备资料。 +- [SpaceVim 用户文档](../documentation/). SpaceVim 官方文档,包含了 SpaceVim 配置及使用的每一个细节,是熟悉和掌握 SpaceVim 使用技巧的必备资料。 - [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim). Tell you how to hack SpaceVim. - [SpaceVim 入门教程](https://everettjf.gitbooks.io/spacevimtutorial/content/):everettjf 所著的 SpaceVim 入门教程