From 536c1cba9459cff5d1773a13531631eeab8be2b5 Mon Sep 17 00:00:00 2001 From: ssfjhh Date: Wed, 16 Jan 2019 23:34:39 +0800 Subject: [PATCH] Doc: Correct documentations by ChineseLinter and fix typos. (#2452) --- README.cn.md | 34 ++--- README.md | 33 ++--- docs/cn/about.md | 32 ++-- docs/cn/api.md | 24 +-- docs/cn/api/data/dict.md | 2 +- docs/cn/api/unicode/spinners.md | 4 +- docs/cn/blog.md | 2 +- docs/cn/community.md | 6 +- docs/cn/conventions.md | 74 +++++----- docs/cn/development.md | 14 +- docs/cn/documentation.md | 136 ++++++++--------- docs/cn/faq.md | 20 +-- docs/cn/index.md | 18 +-- docs/cn/layers.md | 163 +++++++++++---------- docs/cn/layers/autocomplete.md | 4 +- docs/cn/layers/chat.md | 3 +- docs/cn/layers/checkers.md | 2 +- docs/cn/layers/chinese.md | 2 +- docs/cn/layers/colorscheme.md | 3 +- docs/cn/layers/core.md | 2 +- docs/cn/layers/core/banner.md | 6 +- docs/cn/layers/core/statusline.md | 4 +- docs/cn/layers/core/tabline.md | 10 +- docs/cn/layers/cscope.md | 6 +- docs/cn/layers/ctrlp.md | 4 +- docs/cn/layers/debug.md | 34 ++--- docs/cn/layers/default.md | 4 +- docs/cn/layers/denite.md | 6 +- docs/cn/layers/edit.md | 11 +- docs/cn/layers/floobits.md | 6 +- docs/cn/layers/format.md | 2 +- docs/cn/layers/fzf.md | 4 +- docs/cn/layers/git.md | 2 +- docs/cn/layers/github.md | 2 +- docs/cn/layers/japanese.md | 4 +- docs/cn/layers/lang/WebAssembly.md | 4 +- docs/cn/layers/lang/agda.md | 4 +- docs/cn/layers/lang/asciidoc.md | 4 +- docs/cn/layers/lang/autohotkey.md | 4 +- docs/cn/layers/lang/c.md | 14 +- docs/cn/layers/lang/clojure.md | 5 +- docs/cn/layers/lang/csharp.md | 4 +- docs/cn/layers/lang/dart.md | 30 ++-- docs/cn/layers/lang/dockerfile.md | 6 +- docs/cn/layers/lang/elixir.md | 2 +- docs/cn/layers/lang/elm.md | 6 +- docs/cn/layers/lang/extra.md | 6 +- docs/cn/layers/lang/fsharp.md | 4 +- docs/cn/layers/lang/go.md | 12 +- docs/cn/layers/lang/haskell.md | 5 +- docs/cn/layers/lang/html.md | 2 +- docs/cn/layers/lang/php.md | 4 +- docs/cn/layers/lang/plantuml.md | 4 +- docs/cn/layers/lang/puppet.md | 4 +- docs/cn/layers/lang/purescript.md | 8 +- docs/cn/layers/lang/scheme.md | 4 +- docs/cn/layers/lang/sh.md | 14 +- docs/cn/layers/lang/swift.md | 6 +- docs/cn/layers/lang/typescript.md | 8 +- docs/cn/layers/lang/vim.md | 4 +- docs/cn/layers/lang/vue.md | 4 +- docs/cn/layers/language-server-protocol.md | 12 +- docs/cn/layers/leaderf.md | 6 +- docs/cn/layers/shell.md | 8 +- docs/cn/layers/sudo.md | 2 +- docs/cn/layers/tags.md | 39 ++--- docs/cn/layers/tmux.md | 6 +- docs/cn/layers/tools.md | 2 +- docs/cn/layers/tools/dash.md | 6 +- docs/cn/layers/ui.md | 2 +- docs/cn/layers/unite.md | 2 +- docs/cn/quick-start-guide.md | 36 +++-- docs/cn/roadmap.md | 2 +- docs/cn/sponsors.md | 152 +++++++++---------- docs/quick-start-guide.md | 2 +- 75 files changed, 566 insertions(+), 566 deletions(-) diff --git a/README.cn.md b/README.cn.md index e936a05e7..ed940e888 100644 --- a/README.cn.md +++ b/README.cn.md @@ -7,16 +7,16 @@ [![Version](https://img.shields.io/badge/version-1.1.0--dev-8700FF.svg)](https://github.com/SpaceVim/SpaceVim/releases) [![GPLv3 License](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/SpaceVim/SpaceVim/blob/master/LICENSE) -SpaceVim 是一个社区驱动的模块化 vim/neovim 配置集合，以模块的方式组织管理插件以 +SpaceVim 是一个社区驱动的模块化 Vim/Neovim 配置集合，以模块的方式组织管理插件以 及相关配置，为不同的语言开发量身定制了相关的开发模块，该模块提供代码自动补全， 语法检查、格式化、调试、REPL 等特性。用户仅需载入相关语言的模块即可得到一个开箱 即用的 Vim-IDE。 -官 网： +官网： -Github : +Github: -码 云 : +码云： ![welcome-page](https://user-images.githubusercontent.com/13142418/50423286-5b33a400-088e-11e9-830c-792ce1c7c126.png) @@ -33,7 +33,7 @@ Github : - [最新特新](#最新特新) - - [多光标Iedit模式](#多光标iedit模式) + - [多光标 Iedit 模式](#多光标-iedit-模式) - [高亮光标下的函数](#高亮光标下的函数) - [实时代码检索](#实时代码检索) - [快捷键辅助导航](#快捷键辅助导航) @@ -42,7 +42,7 @@ Github : - [安装](#安装) - [Linux 或 macOS](#linux-或-macos) - [Windows](#windows) -- [捐助SpaceVim](#捐助spacevim) +- [捐助 SpaceVim](#捐助-spacevim) @@ -50,11 +50,11 @@ Github : 以下为 SpaceVim 中最新实现的一些特性： -### 多光标Iedit模式 +### 多光标 Iedit 模式 SpaceVim 内置了一种特殊的模式，Iedit 模式，这种模式提供了多光标支持，不同于已有插件的实现， -该模式支持两种状态 ：`iedit-Normal` 和 `iedit-Insert`。默认情况下，多光标输入时，`iedit-normal` -模式状态栏时是红色，而 `iedit-insert` 模式时是绿色，当然这根据所选择主题决定。 +该模式支持两种状态：`iedit-Normal` 和 `iedit-Insert`。默认情况下，多光标输入时，`iedit-normal` +模式状态栏时是红色，而 `iedit-insert` 模式时是绿色，当然这由所选择的主题决定。 ![iedit mode](https://user-images.githubusercontent.com/13142418/44941560-be2a9800-add2-11e8-8fa5-e6118ff9ddcb.gif) @@ -62,7 +62,7 @@ SpaceVim 内置了一种特殊的模式，Iedit 模式，这种模式提供了 SpaceVim 支持高亮当前光标函数，并且启动一个特殊模式，在该模式下可以快捷地切换高亮区域 （方法内、屏幕内、整个文件内），并且可以快速在高亮函数间跳转、切换高亮状态（高亮、取消高亮）， -并且可以根据已选择的位置计入 iedit 模式。 +并且可以根据已选择的位置计入 Iedit 模式。 ![highlight cursor symbol](https://user-images.githubusercontent.com/13142418/36210381-e6dffde6-1163-11e8-9b35-0bf262e6f22b.gif) @@ -82,7 +82,7 @@ SpaceVim 自带的 FlyGrep 这个插件可以根据输入实时搜索项目代 ### 快捷键描述系统 -通过快捷键描述系统，你可以清楚的了解到一个快捷键的功能，并且可以快速跳转到快捷键定义的位置; +通过快捷键描述系统，你可以清楚的了解到一个快捷键的功能，并且可以快速跳转到快捷键定义的位置； 比如，通过 `SPC h d k` 启动快捷键描述系统，然后按下所需描述快捷键 `SPC b n`，就会弹出一个描述 窗口，在改窗口可以通过快捷键 `gd` 快速跳转到快捷键定义处。 @@ -90,7 +90,7 @@ SpaceVim 自带的 FlyGrep 这个插件可以根据输入实时搜索项目代 ### 异步插件管理器 -SpaceVim 利用了 vim8 和 neovim 最新的异步机制，实现了一套异步插件下载及更新插件，而插件运行管理采用的是 [dein.vim](https://github.com/Shougo/dein.vim/)。 +SpaceVim 利用了 Vim 8 和 Neovim 最新的异步机制，实现了异步插件下载及更新，而插件运行管理采用的是 [dein.vim](https://github.com/Shougo/dein.vim/)。 ![UI for dein](https://user-images.githubusercontent.com/13142418/34907332-903ae968-f842-11e7-8ac9-07fcc9940a53.gif) @@ -104,7 +104,7 @@ SpaceVim 利用了 vim8 和 neovim 最新的异步机制，实现了一套异步 curl -sLf https://spacevim.org/cn/install.sh | bash ``` -安装结束后，初次打开 `vim` 或者 `gvim` 时， SpaceVim 会**自动**下载并安装插件。 +安装结束后，初次打开 `Vim` 或者 `gVim` 时，SpaceVim 会**自动**下载并安装插件。 如果需要获取安装脚本的帮助信息，可以执行如下命令，包括定制安装、更新和卸载等。 @@ -114,10 +114,10 @@ curl -sLf https://spacevim.org/cn/install.sh | bash -s -- -h ### Windows -window 下最快捷的安装方法是下载安装脚本 [install.cmd](https://spacevim.org/cn/install.cmd) 并运行。 +Windows 下最快捷的安装方法是下载安装脚本 [install.cmd](https://spacevim.org/cn/install.cmd) 并运行。 -## 捐助SpaceVim +## 捐助 SpaceVim -| 微信 | 支付宝 | -| ------------------------------------------------------------------------ | -------------------------------------------------------------------------- | +| 微信 | 支付宝 | +| -------------------------------------------------------- | ---------------------------------------------------------- | | | | diff --git a/README.md b/README.md index e7a660213..0412bb075 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ ## About SpaceVim -SpaceVim is a community-driven modular vim distribution. It manages collections -of plugins in layers, which help collect related packages together to provide IDE-like features. +SpaceVim is a community-driven modular Vim distribution. It manages collections +of plugins in layers, which help to collect related packages together to provide IDE-like features. SpaceVim is not just a vimrc but an ultimate Vim configuration, It contains many built-in features. ![welcome-page](https://user-images.githubusercontent.com/13142418/50423286-5b33a400-088e-11e9-830c-792ce1c7c126.png) @@ -56,15 +56,15 @@ This is a list of latest features implemented in SpaceVim: **Use toml as default configuration** -here is an example for using toml as SpaceVim config: +Here is an example for using toml as SpaceVim config: ```toml # This is basic configuration example for SpaceVim -# All SpaceVim option below [option] section +# All SpaceVim options 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 + # if you want to use more colorschemes, please load the colorscheme # layer colorscheme = "gruvbox" colorscheme_bg = "dark" @@ -80,7 +80,7 @@ here is an example for using toml as SpaceVim config: enable_tabline_filetype_icon = false enable_statusline_mode = false statusline_unicode_symbols = false - # Enable vim compatible mode, avoid changing origin vim key bindings + # Enable Vim compatible mode, avoid changing origin Vim key bindings vimcompatible = true # Enable autocomplete layer @@ -97,7 +97,7 @@ default_height = 30 **Iedit mode** -SpaceVim uses powerful iedit mode to quick edit multiple occurrences of a symbol or selection. Two new modes:`iedit-Normal`/`iedit-Insert` +SpaceVim uses a powerful iedit mode to quick edit multiple occurrences of a symbol or selection. Two new modes:`iedit-Normal`/`iedit-Insert`. The default color for iedit is `red`/`green` which is based on the current colorscheme. @@ -112,7 +112,7 @@ a transient state to easily navigate and rename this symbol. [**Fly Grep in Vim**](https://spacevim.org/grep-on-the-fly-in-spacevim/) -With this feature, vim will display the searching result as you type. Of course, it is running +With this feature, Vim will display the searching result as you type. Of course, it is running asynchronously. Before using this feature, you need to install a searching tool. FlyGrep works through search tools: `ag`, `rg`, `ack`, `pt` and `grep`, Choose one you like. @@ -127,13 +127,13 @@ The mapping guide is also available for `g`, `z`, and `s`. [**Help description for key bindings**](https://spacevim.org/help-description-for-key-bindings/) -use SPC h d k to get the help description of a key binding, and `gd` to find definition of key bindings. +Use SPC h d k to get the help description of a key binding, and `gd` to find definition of key bindings. ![describe key bindings](https://user-images.githubusercontent.com/13142418/35568829-e3c8e74c-058f-11e8-8fa8-c0e046d8add3.gif) [**Asynchronous plugin manager**](https://spacevim.org/Asynchronous-plugin-manager/) -create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asynchronous vim plugin manager +Create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asynchronous vim plugin manager ![UI for dein](https://user-images.githubusercontent.com/13142418/34907332-903ae968-f842-11e7-8ac9-07fcc9940a53.gif) @@ -159,13 +159,12 @@ For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/) ### Support SpaceVim -The best way to support SpaceVim is to contribute to it either by reporting bugs, -helping the community on the [Gitter Chat](https://gitter.im/SpaceVim/SpaceVim) or sending pull requests. +The best way to support SpaceVim is to contribute to it either by reporting bugs. +Helping the community on the [Gitter Chat](https://gitter.im/SpaceVim/SpaceVim) or sending pull requests. -For more info please check our [development guidelines](https://spacevim.org/development/). +For more information please check our [development guidelines](https://spacevim.org/development/). -If you want to show your support financially you can buy a drink for the maintainer by -clicking following icon. +If you want to show your support financially you can buy a drink for the maintainer by clicking following icon. Buy Me a Coffee at ko-fi.com @@ -177,7 +176,7 @@ Bitcoin: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv ### Credits & Thanks -This project exists thanks to all the people who have [contributed](CONTRIBUTING.md): +This project exists to thank all the people who have [contributed](CONTRIBUTING.md): - [@Gabirel](https://github.com/Gabirel) and his [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim) @@ -185,6 +184,6 @@ This project exists thanks to all the people who have [contributed](CONTRIBUTING - [vimdoc](https://github.com/google/vimdoc) generate doc file for SpaceVim - [Rafael Bodill](https://github.com/rafi) and his vim-config - [Bailey Ling](https://github.com/bling) and his dotvim -- authors of all the plugins used in SpaceVim. +- Authors of all the plugins used in SpaceVim. diff --git a/docs/cn/about.md b/docs/cn/about.md index c03daaaac..62967a337 100644 --- a/docs/cn/about.md +++ b/docs/cn/about.md @@ -1,6 +1,6 @@ --- -title: "关于" -description: "SpaceVim 是一个社区驱动的模块化 vim 配置，以模块的方式组织管理插件和配置" +title: "关于" +description: "SpaceVim 是一个社区驱动的模块化的 Vim IDE，以模块的方式组织管理插件和配置。" lang: cn --- @@ -8,27 +8,27 @@ lang: cn ## 版本 -[SpaceVim](https://github.com/SpaceVim/SpaceVim) 是一个社区驱动的 vim 配置，支持 vim 和 neovim。SpaceVim -使用模块的方式来组织插件，对新手更加友好。 +[SpaceVim](https://github.com/SpaceVim/SpaceVim) 是一个社区驱动的 Vim 配置，支持 Vim 和 Neovim。 +SpaceVim 使用模块的方式来组织插件，对新手更加友好。 ## 目标 -- 提供可跨平台的优雅的用户体验. -- 为不同语言开发提供完整的解决方案. +- 提供可跨平台的优雅的用户体验。 +- 为不同语言开发提供完整的解决方案。 ## 标准 -- 兼容 Vim 和 Neovim，尽量确保 Vim下和 Neovim 下有相同的用户体验 -- 兼容 Vim 7.4 或者无 +py/+py3/+lua等特性的Vim -- 不要从 origin 回归. -- 通过权衡成本和收益来决定结果. -- 收益与传统相比较,当收益是压倒性的时候,我们选择收益,而非坚持传统. -- 给可用性一个机会. +- 兼容 Vim 和 Neovim，尽量确保 Vim 下和 Neovim 下有相同的用户体验 +- 兼容 Vim 7.4 或者无 +py/+py3/+lua 等特性的 Vim +- 不要从 origin 回归 +- 通过权衡成本和收益来决定结果 +- 收益与传统相比较，当收益是压倒性的时候，我们选择收益，而非坚持传统 +- 给可用性一个机会 ## 鸣谢 -- 开发者: [Wang Shidong](https://github.com/wsdjeg) +- 开发者：[Wang Shidong](https://github.com/wsdjeg) - [![贡献者](https://img.shields.io/github/contributors/SpaceVim/SpaceVim.svg)](https://github.com/SpaceVim/SpaceVim/graphs/contributors) -- [vimdoc](https://github.com/google/vimdoc) 自动生成 vim 文档 -- [Rafael Bodill](https://github.com/rafi) 的 vim 配置 -- [Bailey Ling](https://github.com/bling) 的 vim 配置 +- [vimdoc](https://github.com/google/vimdoc) 自动生成 Vim 文档 +- [Rafael Bodill](https://github.com/rafi) 的 Vim 配置 +- [Bailey Ling](https://github.com/bling) 的 Vim 配置 diff --git a/docs/cn/api.md b/docs/cn/api.md index 96b992cfb..0e541c88f 100644 --- a/docs/cn/api.md +++ b/docs/cn/api.md @@ -1,6 +1,6 @@ --- title: "公共 API" -description: "SpaceVim 公共 API 提供了一套开发插件的公共函数，以及 neovim 和 vim 的兼容组件" +description: "SpaceVim 公共 API 提供了一套开发插件的公共函数，以及 Neovim 和 Vim 的兼容组件。" lang: cn --- @@ -23,7 +23,7 @@ lang: cn 可以通过 `SpaceVim#api#import()` 函数导入相关 API，参考以下示例： -```viml +```vim " 导入 file API，并赋值给变量 s:file let s:file = SpaceVim#api#import('file') " 导入 system API，并赋值给变量 s:system @@ -31,7 +31,7 @@ let s:system = SpaceVim#api#import('system') " 调用 system API 的 isWindows 成员变量 if s:system.isWindows - echom "Os is Windows" + echom "OS is Windows" endif echom s:file.separator echom s:file.pathSeparator @@ -43,14 +43,14 @@ echom s:file.pathSeparator ## 可用 APIs -| 名称 | 描述 | -| ------------------------------------- | ----------------------------------------------------------------------- | -| [data#dict](data/dict/) | data#dict api 提供了一些处理字典变量的常用方法 | -| [file](file/) | 文件函数提供了基础的文件读写相关函数，兼容不同系统平台。 | -| [job](job/) | 兼容 neovim 和 vim 的异步协同 API，对于旧版 vim 采用非异步机制 | -| [system](system/) | system 函数提供了系统相关函数，包括判断当前系统平台，文件格式等函数。 | -| [unicode#spinners](unicode/spinners/) | unicode#spinners API 可启用一个定时器，根据指定的名称定时更新进度条符号 | -| [vim#command](vim/command/) | vim#command API 提供一些设置和获取 Vim 命令的基础函数。 | -| [vim#highlight](vim/highlight/) | vim#highlight API 提供一些设置和获取 Vim 高亮信息的基础函数。 | +| 名称 | 描述 | +| ------------------------------------- | ------------------------------------------------------------------------- | +| [data#dict](data/dict/) | data#dict API 提供了一些处理字典变量的常用方法，包括基础的增删改查。 | +| [file](file/) | 文件函数提供了基础的文件读写相关函数，兼容不同系统平台。 | +| [job](job/) | 兼容 Neovim 和 Vim 的异步协同 API，对于旧版 Vim 采用非异步机制。 | +| [system](system/) | system 函数提供了系统相关函数，包括判断当前系统平台，文件格式等函数。 | +| [unicode#spinners](unicode/spinners/) | unicode#spinners API 可启用一个定时器，根据指定的名称定时更新进度条符号。 | +| [vim#command](vim/command/) | vim#command API 提供一些设置和获取 Vim 命令的基础函数。 | +| [vim#highlight](vim/highlight/) | vim#highlight API 提供一些设置和获取 Vim 高亮信息的基础函数。 | diff --git a/docs/cn/api/data/dict.md b/docs/cn/api/data/dict.md index 2385491db..9f8baaf7b 100644 --- a/docs/cn/api/data/dict.md +++ b/docs/cn/api/data/dict.md @@ -1,6 +1,6 @@ --- title: "data#dict api" -description: "data#dict api 提供了一些处理字典变量的常用方法" +description: "data#dict API 提供了一些处理字典变量的常用方法，包括基础的增删改查。" --- # [Available APIs](../../) >> data#dict diff --git a/docs/cn/api/unicode/spinners.md b/docs/cn/api/unicode/spinners.md index 96fa456da..1455c1b58 100644 --- a/docs/cn/api/unicode/spinners.md +++ b/docs/cn/api/unicode/spinners.md @@ -18,8 +18,8 @@ lang: cn unicode#spinners API 主要提供一个 apply 函数，可根据名称定时更新某个变量的值，实现进度条效果： ```vim -let s:SPI = SpaceVim#api#import('unicode#spinners') -call s:SPI.apply('dot1', 'g:dotstr') +let s:SPI = SpaceVim#api#import('unicode#spinners') +call s:SPI.apply('dot1', 'g:dotstr') set statusline+=%{g:dotstr} ``` diff --git a/docs/cn/blog.md b/docs/cn/blog.md index 539f1ce39..6c72e5d7d 100644 --- a/docs/cn/blog.md +++ b/docs/cn/blog.md @@ -6,7 +6,7 @@ lang: cn # SpaceVim 中文博客 -SpaceVim 中文博客主要公布最新版本发布、新特性预览、以及一些 SpaceVim 及 Vim +SpaceVim 中文博客主要公布最新版本发布、新特性预览以及一些 SpaceVim 及 Vim 相关的使用教程，可通过 RSS [订阅本博客](../../feed.xml)：
    diff --git a/docs/cn/community.md b/docs/cn/community.md index 54a08c484..fb6ea6db9 100644 --- a/docs/cn/community.md +++ b/docs/cn/community.md @@ -1,5 +1,5 @@ --- -title: "中文社区" +title: "中文社区" description: "SpaceVim 中文社区，包括中文技术问答、资讯订阅、Bug 提交以及需求提交，让沟通更加便利。" lang: cn --- @@ -27,8 +27,8 @@ lang: cn 在正常使用 SpaceVim 时，如果遇到 Bug 或者有新的特性需求可以通过 Github 或者码云的问题列表来提交。 -- [码云](https://gitee.com/spacevim/SpaceVim/issues) - （中文） -- [GitHub](https://github.com/SpaceVim/SpaceVim) - （英文） +- [码云](https://gitee.com/spacevim/SpaceVim/issues) -（中文） +- [GitHub](https://github.com/SpaceVim/SpaceVim) -（英文） ### 邮件列表 diff --git a/docs/cn/conventions.md b/docs/cn/conventions.md index d91718cd4..8905a6c7b 100644 --- a/docs/cn/conventions.md +++ b/docs/cn/conventions.md @@ -1,6 +1,6 @@ --- -title: "约定" -description: "描述贡献代码所需遵循的约定俗成的规范，包括 Vim 脚本的代码规范以及 markdown 文件的代码规范。" +title: "约定" +description: "描述贡献代码所需遵循的约定俗成的规范，包括 Vim 脚本的代码规范以及 MarkDown 文件的代码规范。" lang: cn --- @@ -34,7 +34,7 @@ lang: cn - [连续行](#连续行) - [命名](#命名) - [markdown 代码规范](#markdown-代码规范) -- [感谢:](#感谢) +- [感谢：](#感谢) @@ -80,11 +80,11 @@ Vim 具有高度可定制性。用户可以更改很多的默认设置，包括 **避免命令意想不到的副作用** -避免使用 :s[ubtitute] 因为它引动光标并打印错误消息。首选功能(例如 search()) 比 s[ubtitute] 更适用于脚本。 +避免使用 `:s[ubtitute]` 因为它引动光标并打印错误消息。首选功能(例如 search()) 比 s[ubtitute] 更适用于脚本。 -这意味着 g 标志取决于上层中 gdefault 设置。如果你用了 :subtitute 你必须要保存 gdefault, 把它设置为 0 或 1 预先生成替换并且在操作完成后还原它。 -For many Vim commands, functions exist that do the same thing with fewer side effects. See :help functions() for a list of built-in functions. -有很多内置的Vim命令，函数，可以在更小的影响下完成同样的事情。查看:help functions() 查看内置的函数表。 +这意味着 g 标志取决于上层中 gdefault 设置。如果你用了 `:subtitute` 你必须要保存 gdefault, 把它设置为 0 或 1 预先生成替换并且在操作完成后还原它。 +For many Vim commands, functions exist that do the same thing with fewer side effects. See `:help functions()` for a list of built-in functions. +有很多内置的 Vim 命令，函数，可以在更小的影响下完成同样的事情。查看 `:help functions()` 查看内置的函数表。 #### 脆弱命令 @@ -92,7 +92,7 @@ For many Vim commands, functions exist that do the same thing with fewer side ef 一直使用普通模式(normal) 在普通模式下安装。后者取决于用户的按键映射，可以做任何事情。 -避免 `:s[ubtitute]` ，因为它的行为取决于上层的一些运行设置。 +避免 `:s[ubtitute]`，因为它的行为取决于上层的一些运行设置。 其它同样的命令的应用，在此不再列出。 @@ -123,7 +123,7 @@ Vim 脚本在处理一些类型(style)时有不安全，不直观的行为。举 在使用变量前，明确检查变量的类型。使用 maktaba#ensure 中的函数(functions from maktaba#ensure) 或 check maktaba#value 或 type() 找出你自己的错误。 -使用 :unlet 对变量使用(:unlet)可能更改变量的类型，尤其是在循环中赋值的时候。 +使用 `:unlet` 对变量使用(:unlet)可能更改变量的类型，尤其是在循环中赋值的时候。 #### Python @@ -135,13 +135,13 @@ Vim 脚本在处理一些类型(style)时有不安全，不直观的行为。举 **用 Vim 脚本替代** -避免使用其它的脚本语言，例如 Ruby 和 Lua 。 我们不能保证，用户的 Vim 已经完成了对 non-vimscript languages的支持。 +避免使用其它的脚本语言，例如 Ruby 和 Lua 。 我们不能保证，用户的 Vim 已经完成了对 non-vimscript languages 的支持。 #### 插件布局 **将功能组织到模块化插件中** -把你的功能组织成为一个插件，统一放在一个文件夹中(或者是代码仓库)分享你的插件名(用一个 "vim-" 前缀或者需要的话使用 ".vim" 后缀)。它应该可以被拆分到 plugin/, autoload/, 等等。子目录应该以addon-info.json格式声明元数据(详情参见 VAM 文档)。 +把你的功能组织成为一个插件，统一放在一个文件夹中(或者是代码仓库)分享你的插件名(用一个 "vim-" 前缀或者需要的话使用 ".vim" 后缀)。它应该可以被拆分到 plugin/, autoload/, 等等。子目录应该以 addon-info.json 格式声明元数据(详情参见 VAM 文档)。 #### 功能 @@ -159,7 +159,7 @@ Vim 脚本在处理一些类型(style)时有不安全，不直观的行为。举 #### 命令 -**在 plugin/commands.vim 中或 the ftplugin/ 目录中，不用[!]定义** +**在 plugin/commands.vim 中或 ftplugin/ 目录中，不用[!]定义** 一般命令(general commands)进入 plugin/commands.vim. 文件类型特殊命令(Filetype-specific) 进入 ftplugin/ 。 @@ -177,11 +177,11 @@ Excluding [!] prevents your plugin from silently clobbering existing commands. C #### 映射 -**在 plugin/mappings.vim 中用 maktaba#plugin#MapPrefix 获取前缀** +**在 plugin/mappings.vim 中用 maktaba#plugin#MapPrefix 获取前缀** 所有的按键映射都应当在 plugin/mappings.vim 中被定义。 -练习映射(参看:help using-)应当在 plugin/plugs.vim 中被定义。 +练习映射(参看`:help using-`)应当在 plugin/plugs.vim 中被定义。 **一直使用 noremap family 命令** @@ -195,7 +195,7 @@ Excluding [!] prevents your plugin from silently clobbering existing commands. C **在本地更改设置** -用 :setlocal 和 &l: 替代 :set 和 & 除非你有明确的原因不去使用它们。 +用 `:setlocal` 和 &l: 替代 `:set` 和 & 除非你有明确的原因不去使用它们。 ### 风格 @@ -203,10 +203,10 @@ Excluding [!] prevents your plugin from silently clobbering existing commands. C #### 空白行 -**类似python** +**类似 Python** - 缩进使用两个空格 -- 不要使用tabs +- 不要使用 Tabs - 在操作符(operators)前后使用空格 不要以参数列表(arguments)的形式来使用命令。 @@ -218,10 +218,10 @@ command -range=% MyCommand 你无需用自己的方法去清除它。 -准备获取用户输入的命令映射中允许留空白字符，例如 "noremap gf :grep -f " +准备获取用户输入的命令映射中允许留空白字符，例如 `noremap gf :grep -f` -- 每行限制80个字符的宽度 -- 缩进保持4个空格 +- 每行限制 80 个字符的宽度 +- 缩进保持 4 个空格 - 不要对齐命令的参数列表 ```diff @@ -242,7 +242,7 @@ command -range=% MyCommand - \ some#function() ``` -- 反斜杠后添加一个空格代表续行。 +- 反斜杠后添加一个空格代表续行 如果需要连续使用多行命令，可以使用管道符来代替空格，就像下面这样： @@ -255,17 +255,17 @@ autocommand BufEnter \|endif ``` -- 你应该尽量避免使用多行命令，可以用函数调用来替代它。 +- 你应该尽量避免使用多行命令，可以用函数调用来替代它 #### 命名 -总的来说，使用像这样的插件名 plugin-names-like-this ，像这样的函数名 FunctionNamesLikeThis ，像这样的命令名 CommandNamesLikeThis ，像这样的参数组 augroup_names_like_this ，像这样的变量名 variable_names_like_this 。 +总的来说，使用像这样的插件名 plugin-names-like-this，像这样的函数名 FunctionNamesLikeThis，像这样的命令名 CommandNamesLikeThis，像这样的参数组 augroup_names_like_this，像这样的变量名 variable_names_like_this 。 总是在变量名前加上它们的范围前缀 - plugin-names-like-this 保持简单易于理解 - FunctionNamesLikeThis - - 本地脚本函数的前缀为s: + - 本地脚本函数的前缀为`s:` - 自动运行函数(autoload functions)可以没有范围前缀。 - 不要编写(creat)全局函数。用自动运行函数(autoloaded functions)来替代全局函数。 - CommandNamesLikeThis @@ -274,21 +274,21 @@ autocommand BufEnter Augroup names count as variables for naming purposes. 参数组(augroup)名字计数作为变量的命名方向。 - 所有的变量据需要加上它们的范围前缀。 - - 全局变量的前缀为 g: - - 本地脚本变量的前缀为 s: - - 函数的参数前缀为 a: - - 本地函数的变量前缀为 l: - - Vim 预定义(Vim-predefinded)变量前缀为 v: - - 本地缓冲区(Buffer-local)变量的前缀为 b: - - g:, s:, 和 a: 前缀必须使用。 - - b: 当你想要改变本地缓冲区(buffer-local)的变量的语义时前缀为 b: - - l: and v: should be used for consistency, future proofing, and to avoid subtle bugs. They are not strictly required. Add them in new code but don’t go out of your way to add them elsewhere. + - 全局变量的前缀为`g:` + - 本地脚本变量的前缀为`s:` + - 函数的参数前缀为`a:` + - 本地函数的变量前缀为`l:` + - Vim 预定义(Vim-predefinded)变量前缀为`v:` + - 本地缓冲区(Buffer-local)变量的前缀为`b:` + - `g:`, `s:`, 和 `a:` 前缀必须使用 + - `b:` 当你想要改变本地缓冲区(buffer-local)的变量的语义时前缀为 `b:` + - `l:` and v: should be used for consistency, future proofing, and to avoid subtle bugs. They are not strictly required. Add them in new code but don’t go out of your way to add them elsewhere. ## markdown 代码规范 -## 感谢: +## 感谢： -- link : -- link : -- link : +- link: +- link: +- link: - [google's markdown style guide](https://github.com/google/styleguide/blob/3591b2e540cbcb07423e02d20eee482165776603/docguide/style.md) diff --git a/docs/cn/development.md b/docs/cn/development.md index a23dc03d8..0deb4084e 100644 --- a/docs/cn/development.md +++ b/docs/cn/development.md @@ -1,5 +1,5 @@ --- -title: "开发者文档" +title: "开发者文档" description: "本文档是 SpaceVim 开发者文档，描述了：1. 如何提交问题 2. 如何贡献代码 3. 代码格式规则 4. 版本迭代信息" lang: cn --- @@ -45,10 +45,10 @@ SpaceVim 是每个志愿者的努力的结晶，我们鼓励你参与进来，Sp ## 寻求帮助 -在你建立 issue 之前，先确认你已经浏览过下面的 faq 以及 SpaceVim 文档。 +在你建立 issue 之前，先确认你已经浏览过下面的 FAQ 以及 SpaceVim 文档。 - :h SpaceVim-faq: 一些常见问题及解决方法 -- [SpaceVim documentation](https://spacevim.org/cn/documentation): SpaceVim的官方文档 +- [SpaceVim documentation](https://spacevim.org/cn/documentation): SpaceVim 的官方文档 ## 反馈问题 @@ -61,7 +61,7 @@ SpaceVim 是每个志愿者的努力的结晶，我们鼓励你参与进来，Sp - 按照下面的问题格式，建立清晰的问题标题 -- 包括 bug 出现的细节，一步一步重现 bug 出现的操作 +- 包括 Bug 出现的细节，一步一步重现 Bug 出现的操作 ## 贡献代码 @@ -137,8 +137,8 @@ Those PRs are merged and explicitly not fast-forwarded. - 用现在时和祈使句：例如"Fix bug"，而不是"fixed bug" 或者"fixes bug"。 -- 以大写字母开头，短摘要开头(72个字符或者更少)，以空行结尾。 -- 如果需要的话，可以用每行72个字符的格式添加一个或多个详细的段落。 +- 以大写字母开头，短摘要开头（72 个字符或者更少），以空行结尾。 +- 如果需要的话，可以用每行 72 个字符的格式添加一个或多个详细的段落。 - 每个独立的段落以空行结尾。 这是一个提交信息的模版： @@ -198,7 +198,7 @@ You should replace FILENAME by the name of the file (e.g. foo.vim) and NAME by t 把文件头中的默认作者名字(Shidong Wang)改为你自己的名字。 -下面是一个创建一个名字为`foo`的新的 layer 的实例 +下面是一个创建一个名字为`foo`的新 layer 的实例 1. fork SpaceVim repo 2. add a layer file `autoload/SpaceVim/layers/foo.vim` for `foo` layer. diff --git a/docs/cn/documentation.md b/docs/cn/documentation.md index 7576d986e..147f35d8c 100644 --- a/docs/cn/documentation.md +++ b/docs/cn/documentation.md @@ -121,13 +121,13 @@ lang: cn ## 显著特性 -- **详细的文档:** 在 SpaceVim 中通过`:h SpaceVim`来访问 SpaceVim 帮助文档。 -- **优雅简洁的界面:** 你将会喜欢这样的优雅而实用的界面。 -- **确保手指不离开主键盘区域:** 使用 Space 作为前缀键，合理组织快捷键，确保手指不离开主键盘区域。 -- **快捷键辅助系统:** SpaceVim 所有快捷键无需记忆，当输入出现停顿，会实时提示可用按键及其功能。 -- **更快的启动时间:** 得益于 dein.vim, SpaceVim 中 90% 的插件都是按需载入的。 -- **更少的肌肉损伤:** 频繁使用空格键，取代 `ctrl`，`shift` 等按键，大大减少了手指的肌肉损伤。 -- **更易扩展:** 依照一些[约定](http://spacevim.org/cn/development/)，很容易将现有的插件集成到 SpaceVim 中来。 +- **详细的文档：** 在 SpaceVim 中通过`:h SpaceVim`来访问 SpaceVim 帮助文档。 +- **优雅简洁的界面：** 你将会喜欢这样的优雅而实用的界面。 +- **确保手指不离开主键盘区域：** 使用 Space 作为前缀键，合理组织快捷键，确保手指不离开主键盘区域。 +- **快捷键辅助系统：** SpaceVim 所有快捷键无需记忆，当输入出现停顿，会实时提示可用按键及其功能。 +- **更快的启动时间：** 得益于 dein.vim, SpaceVim 中 90% 的插件都是按需载入的。 +- **更少的肌肉损伤：** 频繁使用空格键，取代 `ctrl`，`shift` 等按键，大大减少了手指的肌肉损伤。 +- **更易扩展：** 依照一些[约定](http://spacevim.org/cn/development/)，很容易将现有的插件集成到 SpaceVim 中来。 - **完美支持 Neovim:** 依赖于 Neovim 的 romote 插件以及异步 API，SpaceVim 运行在 Neovim 下将有更加完美的体验。 ## 运行截图 @@ -174,7 +174,7 @@ Neovim 运行在 iTerm2 上，采用 SpaceVim，配色为：_base16-solarized-da **通过 git 进行更新** -可通过在 SpaceVim 目录中手动执行 `git pull`，SpaceVim 在 Windows 下默认目录为 `~/vimfilers`, 但在 Linux 下则可使用如下命令： +可通过在 SpaceVim 目录中手动执行 `git pull`，SpaceVim 在 Windows 下的默认目录为 `~/vimfilers`, 但在 Linux 下则可使用如下命令： `git -C ~/.SpaceVim pull` ### 更新插件 @@ -306,7 +306,7 @@ SpaceVim 的[模块首页](../layers/)。 比如，调试内置语法检查插件 neomake.vim ```toml -[option] +[options] disabled_plugins = ["neomake.vim"] ``` @@ -449,21 +449,21 @@ SpaceVim 在终端下默认使用了真色，因此使用之前需要确认下 | `SPC t m T` | 显示/隐藏状态栏 | | `SPC t m v` | 显示/隐藏版本控制信息 | -**nerd 字体安装:** +**nerd 字体安装：** SpaceVim 默认使用 `nerd fonts`，可参阅其安装指南进行安装。 -**语法检查信息:** +**语法检查信息：** 状态栏中语法检查信息元素如果被启用了，当语法检查结束后，会在状态栏中展示当前语法错误和警告的数量。 -**搜索结果信息:** +**搜索结果信息：** 当使用 `/` 或 `?` 进行搜索时，或当按下 `n` 或 `N` 后，搜索结果序号将被展示在状态栏中，类似于 `20/22` 显示搜索结果总数以及当前结果的序号。具体的效果图如下： ![search status](https://cloud.githubusercontent.com/assets/13142418/26313080/578cc68c-3f3c-11e7-9259-a27419d49572.png) -**电池状态信息:** +**电池状态信息：** _acpi_ 可展示电池电量剩余百分比。 @@ -477,7 +477,7 @@ _acpi_ 可展示电池电量剩余百分比。 所有的颜色都取决于不同的主题。 -**状态栏分割符:** +**状态栏分割符：** 可通过使用 `statusline_separator` 来定制状态栏分割符，例如使用非常常用的方向箭头作为状态栏分割符： @@ -495,7 +495,7 @@ SpaceVim 所支持的分割符以及截图如下： | `nil` | ![separator-nil](https://cloud.githubusercontent.com/assets/13142418/26249776/645a5a96-3cda-11e7-9655-0aa1f76714f4.png) | | `fire` | ![separator-fire](https://cloud.githubusercontent.com/assets/13142418/26274142/434cdd10-3d75-11e7-811b-e44cebfdca58.png) | -**SpaceVim 功能模块:** +**SpaceVim 功能模块：** 功能模块可以通过 `SPC t m m` 快捷键显示或者隐藏。默认使用 Unicode 字符，可通过设置 `statusline_unicode_symbols = false` 来启用 ASCII 字符。(或许在终端中无法设置合适的字体时，可使用这一选项)。 @@ -633,30 +633,30 @@ SpaceVim 选项 `window_leader` 的值来设为其他按键： SpaceVim has mapped normal `q` as smart buffer close, the normal func of `q` can be get by ` q r` -| Key | Mode | Action | +| Key | Mode | Action | | --------------------- | :-----------: | ------------------------------------------------------------------------------ | -| ``+`y` | visual | Copy selection to X11 clipboard ("+y) | -| `Ctrl`+`c` | Normal | Copy full path of current buffer to X11 clipboard | -| ``+`Ctrl`+`c` | Normal | Copy github.com url of current buffer to X11 clipboard(if it is a github repo) | +| ``+`y` | visual | Copy selection to X11 clipboard ("+y) | +| `Ctrl`+`c` | Normal | Copy full path of current buffer to X11 clipboard | +| ``+`Ctrl`+`c` | Normal | Copy github.com url of current buffer to X11 clipboard(if it is a github repo) | | ``+`Ctrl`+`l` | Normal/visual | Copy github.com url of current lines to X11 clipboard(if it is a github repo) | | ``+`p` | Normal/visual | Paste selection from X11 clipboard ("+p) | -| `Ctrl`+`f` | Normal | Smart page forward (C-f/C-d) | -| `Ctrl`+`b` | Normal | Smart page backwards (C-b/C-u) | -| `Ctrl`+`e` | Normal | Smart scroll down (3C-e/j) | -| `Ctrl`+`y` | Normal | Smart scroll up (3C-y/k) | -| `Ctrl`+`q` | Normal | `Ctrl`+`w` | -| `Ctrl`+`x` | Normal | Switch buffer and placement | -| `Up, Down` | Normal | Smart up and down | -| `}` | Normal | After paragraph motion go to first non-blank char (}^) | +| `Ctrl`+`f` | Normal | Smart page forward (C-f/C-d) | +| `Ctrl`+`b` | Normal | Smart page backwards (C-b/C-u) | +| `Ctrl`+`e` | Normal | Smart scroll down (3C-e/j) | +| `Ctrl`+`y` | Normal | Smart scroll up (3C-y/k) | +| `Ctrl`+`q` | Normal | `Ctrl`+`w` | +| `Ctrl`+`x` | Normal | Switch buffer and placement | +| `Up, Down` | Normal | Smart up and down | +| `}` | Normal | After paragraph motion go to first non-blank char (}^) | | `<` | Visual/Normal | Indent to left and re-select | | `>` | Visual/Normal | Indent to right and re-select | -| `Tab` | Visual | Indent to right and re-select | -| `Shift`+`Tab` | Visual | Indent to left and re-select | -| `gp` | Normal | Select last paste | -| `Q`/`gQ` | Normal | Disable EX-mode () | -| `Ctrl`+`a` | Command | Navigation in command line | -| `Ctrl`+`b` | Command | Move cursor backward in command line | -| `Ctrl`+`f` | Command | Move cursor forward in command line | +| `Tab` | Visual | Indent to right and re-select | +| `Shift`+`Tab` | Visual | Indent to left and re-select | +| `gp` | Normal | Select last paste | +| `Q`/`gQ` | Normal | Disable EX-mode () | +| `Ctrl`+`a` | Command | Navigation in command line | +| `Ctrl`+`b` | Command | Move cursor backward in command line | +| `Ctrl`+`f` | Command | Move cursor forward in command line | ### File Operations @@ -821,7 +821,7 @@ call SpaceVim#custom#SPC('nnoremap', ['f', 't'], 'echom "hello world"', 'test cu **通过 Unite/Denite 浏览快捷键** -可以通过 `SPC ？` 使用 Unite 将当前快捷键罗列出来。然后可以输入快捷键按键字母或者描述，Unite 可以通过模糊匹配，并展示结果。 +可以通过 `SPC ?` 使用 Unite 将当前快捷键罗列出来。然后可以输入快捷键按键字母或者描述，Unite 可以模糊匹配并展示结果。 ![unite-mapping](https://cloud.githubusercontent.com/assets/13142418/25779196/2f370b0a-3345-11e7-977c-a2377d23286e.png) @@ -829,7 +829,7 @@ call SpaceVim#custom#SPC('nnoremap', ['f', 't'], 'echom "hello world"', 'test cu #### 获取帮助信息 -Denite/Unite 是一个强大的信息筛选浏览器，这类似于 emacs 中的 [Helm](https://github.com/emacs-helm/helm)。以下这些快捷键将帮助你快速获取需要的帮助信息： +Denite/Unite 是一个强大的信息筛选浏览器，这类似于 Emacs 中的 [Helm](https://github.com/emacs-helm/helm)。以下这些快捷键将帮助你快速获取需要的帮助信息： | 快捷键 | 描述 | | ----------- | -------------------------------------------------- | @@ -864,7 +864,7 @@ merged = 0 #### 界面元素显示切换 -所有的界面元素切换快捷键都是已 `[SPC] t` 或者 `[SPC] T` 开头的，你可以在快捷键导航中查阅所有快捷键。 +所有的界面元素切换快捷键都以 `[SPC] t` 或 `[SPC] T` 开头，你可以在快捷键导航中查阅所有快捷键。 ### 常规操作 @@ -888,11 +888,11 @@ merged = 0 ###### 快速跳到网址 (TODO) -类似于 Firefox 的 vimperator 的 `f` 键的功能。 +类似于 Firefox 的 Vimperator 的 `f` 键的功能。 | 快捷键 | 描述 | | ------------------------------- | ----------------- | -| `SPC j u`/(`o` for help buffer) | 快速跳到/打开 url | +| `SPC j u`/(`o` for help buffer) | 快速跳到/打开 URL | #### 常用的成对快捷键 @@ -941,7 +941,7 @@ merged = 0 | `SPC j k` | 跳至下一行，并且对齐下一行 | | `SPC j l` | 跳至某一行 (easymotion) | | `SPC j q` | show the dumb-jump quick look tooltip (TODO) | -| `SPC j u` | 跳至窗口某个 url （TODO） | +| `SPC j u` | 跳至窗口某个 URL (TODO) | | `SPC j v` | 跳至某个 Vim 函数的定义处 (TODO) | | `SPC j w` | 跳至 Buffer 中某个单词 (easymotion) | @@ -960,7 +960,7 @@ merged = 0 ##### 窗口操作常用快捷键 -每一个窗口，都有一个编号，该编号显示在状态栏的最前端，可通过 `SPC 编号` 进行快速窗口跳转。 +每一个窗口都有一个编号，该编号显示在状态栏的最前端，可通过 `SPC 编号` 进行快速窗口跳转。 | 快捷键 | 描述 | | ------- | ---------- | @@ -978,14 +978,14 @@ merged = 0 | 快捷键 | 描述 | | -------------------- | ------------------------------------------------------------------------------ | -| `SPC w TAB`/`` | 在统一标签内进行窗口切换 | +| `SPC w TAB`/`` | 在同一标签内进行窗口切换 | | `SPC w =` | 对齐分离的窗口 | | `SPC w b` | force the focus back to the minibuffer (TODO) | | `SPC w c` | 进入阅读模式，浏览当前窗口 (需要 tools 模块) | | `SPC w C` | 选择某一个窗口，并且进入阅读模式 (需要 tools 模块) | | `SPC w d` | 删除一个窗口 | | `SPC u SPC w d` | delete a window and its current buffer (does not delete the file) (TODO) | -| `SPC w D` | 选择一个窗口，并且关闭 | +| `SPC w D` | 选择一个窗口并关闭 | | `SPC u SPC w D` | delete another window and its current buffer using vim-choosewin (TODO) | | `SPC w t` | toggle window dedication (dedicated window cannot be reused by a mode) (TODO) | | `SPC w f` | toggle follow mode (TODO) | @@ -993,17 +993,17 @@ merged = 0 | `SPC w h` | 移至左边窗口 | | `SPC w H` | 将窗口向左移动 | | `SPC w j` | 移至下方窗口 | -| `SPC w J` | 将窗口移至下方 | +| `SPC w J` | 将窗口向下移动 | | `SPC w k` | 移至上方窗口 | -| `SPC w K` | 将窗口移至上方 | +| `SPC w K` | 将窗口向上移动 | | `SPC w l` | 移至右方窗口 | -| `SPC w L` | 将窗口移至右方 | +| `SPC w L` | 将窗口向右移动 | | `SPC w m` | 最大化/最小化窗口（最大化相当于关闭其他窗口）(TODO, now only support maximize) | | `SPC w M` | 选择窗口进行替换 | | `SPC w o` | 按序切换标签页 | | `SPC w p m` | open messages buffer in a popup window (TODO) | | `SPC w p p` | close the current sticky popup window (TODO) | -| `SPC w r` | 按序切换窗口 | +| `SPC w r` | 顺序切换窗口 | | `SPC w R` | 逆序切换窗口 | | `SPC w s or SPC w -` | 水平分割窗口 | | `SPC w S` | 水平分割窗口，并切换至新窗口 | @@ -1018,7 +1018,7 @@ merged = 0 ##### Buffer 操作相关快捷键 -Buffer 操作相关快捷键都是已 `SPC b` 为前缀的： +Buffer 操作相关快捷键都是以 `SPC b` 为前缀的： | 快捷键 | 描述 | | --------------- | ------------------------------------------------------------------------------ | @@ -1196,7 +1196,7 @@ SpaceVim 的文件树提供了版本控制信息的接口，但是这一特性 ### 以 `z` 开头的命令 -当你不记得按键映射时，你可以在普通模式下输入前缀 `z` , 然后你会看到所有以 `z` 为前缀的函数映射。 +当你不记得按键映射时，你可以在普通模式下输入前缀 `z`, 然后你会看到所有以 `z` 为前缀的函数映射。 | 快捷键 | 描述 | | ----------- | -------------------------------------------- | @@ -1256,14 +1256,14 @@ SpaceVim 像下面那样调用不同搜索工具的搜索接口： - [ack](https://beyondgrep.com/) - grep -SpaceVim 中的搜索命令是以 `SPC s` 为前缀的，前一个键是使用的工具，后一个键是范围。 +SpaceVim 中的搜索命令以 `SPC s` 为前缀，前一个键是使用的工具，后一个键是范围。 例如 `SPC s a b`将使用 `ag`在当前所有已经打开的缓冲区中进行搜索。 -如果最后一个键(决定范围)是大写字母，那么就会对当前光标下的单词进行搜索。 -举个例子 `SPC s a b` 将会搜索当前光标下的单词。 +如果最后一个键（决定范围）是大写字母，那么就会对当前光标下的单词进行搜索。 +举个例子 `SPC s a B` 将会搜索当前光标下的单词。 如果工具键被省略了，那么会用默认的搜索工具进行搜索。默认的搜索工具对应在 `g:spacevim_search_tools` -列表中的第一个工具。列表中的工具默认的顺序为: `rg`, `ag`, `pt`, `ack`, `grep`。 +列表中的第一个工具。列表中的工具默认的顺序为：`rg`, `ag`, `pt`, `ack`, `grep`。 举个例子：如果 `rg` 和 `ag` 没有在系统中找到，那么 `SPC s b` 会使用 `pt` 进行搜索。 下表是全部的工具键： @@ -1284,7 +1284,7 @@ SpaceVim 中的搜索命令是以 `SPC s` 为前缀的，前一个键是使用 | 给定目录的文件 | f | | 当前工程 | p | -可以双击按键序列中的第二个键来在当前文件中进行搜索。举个例子: `SPC s a a` 会使用 `ag` 在当前文件中进行搜索。 +可以双击按键序列中的第二个键来在当前文件中进行搜索。举个例子：`SPC s a a` 会使用 `ag` 在当前文件中进行搜索。 注意： @@ -1411,7 +1411,7 @@ endfunction | `SPC s r p` | rg | | `SPC s r P` | rg with default text | -**提示**: 在工程中进行搜索的话，无需提前打开文件。在工程保存目录中使用 `SPC p p` 和　`C-s`　，就比如 `SPC s p`。(TODO) +**提示**: 在工程中进行搜索的话，无需提前打开文件。在工程保存目录中使用 `SPC p p` 和　`C-s`，就比如 `SPC s p`。(TODO) ##### 后台进行工程搜索 @@ -1440,9 +1440,9 @@ endfunction | `SPC s w g` | Get Google suggestions in Vim. Opens Google results in Browser. | | `SPC s w w` | Get Wikipedia suggestions in Vim. Opens Wikipedia page in Browser.(TODO) | -**注意**: 为了在 Vim 中使用谷歌 suggestions，你需要在你的配置文件中加入如下配置： +**注意**: 为了在 Vim 中使用谷歌 suggestions，你需要在你的配置文件的[options]片断中加入如下配置： -`let g:spacevim_enable_googlesuggest = 1` +`enable_googlesuggest = 1` #### 实时代码检索 @@ -1467,7 +1467,7 @@ FlyGrep 缓冲区的按键绑定： #### 保持高亮 -SPaceVim 使用 `g:spacevim_search_highlight_persist` 保持当前搜索结果的高亮状态到下一次搜索。 +SpaceVim 使用 `g:spacevim_search_highlight_persist` 保持当前搜索结果的高亮状态到下一次搜索。 同样可以通过 `SPC s c` 或者运行 ex 命令 `:noh` 来取消搜索结果的高亮表示。 #### 高亮光标下变量 @@ -1594,10 +1594,10 @@ In highlight symbol transient state: #### 增加或减小数字 -| 快捷键 | 描述 | -| --------- | -------------------------------------------------- | -| `SPC n +` | 为光标下的数字加 1 并 initiate transient state | -| `SPC n -` | 为光标下的数字减 1 并 initiate transient state | +| 快捷键 | 描述 | +| --------- | --------------------------------------------------- | +| `SPC n +` | 为光标下的数字加 1 并进入 initiate transient state | +| `SPC n -` | 为光标下的数字减 1 并进入 initiate transient state | In transient state： @@ -1692,7 +1692,7 @@ SpaceVim 默认使用 `utf-8` 码进行编码。下面是 `utf-8` 编码的四 - encoding (enc) : utf-8 - termencoding (tenc) : utf-8 (only supported in Vim) -修复混乱的显示: `SPC e a` 是自动选择文件编码的按键映射。在选择好文件编码方式后，你可以运行下面的代码来修复编码： +修复混乱的显示：`SPC e a` 是自动选择文件编码的按键映射。在选择好文件编码方式后，你可以运行下面的代码来修复编码： ```vim set enc=utf-8 @@ -1739,7 +1739,7 @@ SpaceVim 通过 [neomake](https://github.com/neomake/neomake) fly 工具来进 | `SPC e .` | 错误暂态（error transient state) | 下一个/上一个错误导航键和错误暂态(error transinet state) 可用于浏览语法检查器和位置列表缓冲区的错误， -甚至可检查 Vim 位置列表的所有错误。这包括下面的例子: 在已被保存的位置列表缓冲区进行搜索。 +甚至可检查 Vim 位置列表的所有错误。这包括下面的例子：在已被保存的位置列表缓冲区进行搜索。 默认提示符： | 提示符 | 描述 | 自定义选项 | @@ -1755,9 +1755,9 @@ SpaceVim 中的工程通过 vim-projectionisst 和 vim-rooter 进行管理。当 工程管理的命令以 `p` 开头： -| 快捷键 | 描述 | -| ----------- | ---------------------------------------------- | -| `SPC p '` | 在当前工程的根目录打开 shell（需要shell 模块） | +| 快捷键 | 描述 | +| ----------- | ---------------------------------------------- | +| `SPC p '` | 在当前工程的根目录打开 shell（需要 shell 模块） | #### 在工程中搜索文件 @@ -1771,7 +1771,7 @@ SpaceVim 中的工程通过 vim-projectionisst 和 vim-rooter 进行管理。当 ## EditorConfig -SpaceVim has support for [EditorConfig](http://editorconfig.org/), a configuration file to “define and maintain consistent coding styles between different editors and IDEs.” +SpaceVim has supported for [EditorConfig](http://editorconfig.org/), a configuration file to "define and maintain consistent coding styles between different editors and IDEs." To customize your editorconfig experience, read the [editorconfig-vim package’s documentation](https://github.com/editorconfig/editorconfig-vim/blob/master/README.md). diff --git a/docs/cn/faq.md b/docs/cn/faq.md index d40dd8dc6..343719e84 100644 --- a/docs/cn/faq.md +++ b/docs/cn/faq.md @@ -1,13 +1,13 @@ --- -title: "常见问题" -description: "在使用 SpaceVim 过程中比较常见的一些问题，包括并不限于安装、配置及使用。" +title: "常见问题" +description: "在使用 SpaceVim 过程中比较常见的一些问题，包括并不限于安装、配置及使用。" lang: cn --- # SpaceVim 常见问题解答 这里根据社区反馈的情况，罗列了一些大家经常会问的问题，如果有需要补充的，欢迎使用 -使用 SpaceVim 中文社区频道参与讨论，也可以直接编辑本页，提交 PR。 +使用 SpaceVim 中文社区频道参与讨论，也可以直接编辑本页并提交 PR 。 @@ -29,20 +29,20 @@ lang: cn 如果文件中间出现语法错误，导致解析失败。那么该配置会被完全舍弃，而使用 SpaceVim 的 默认配置，这就大大降低了因配置文件错误导致 SpaceVim 运行出错的可能性。 -在配置文件格式选择时，我们在 json、yaml、xml、toml 这四中文件格式之间也做了比较。 +在配置文件格式选择时，我们在 json、yaml、xml、Toml 这四中文件格式之间也做了比较。 1. yaml 依赖缩进，配置转移时易出错，不予考虑 -2. xml 缺少 vim 解析库， 不予考虑 +2. xml 缺少 Vim 解析库，不予考虑 3. json 时一个比较好的配置信息传输格式，并且 Vim 有一个解析的函数，但是 json 格式 -不支持注释，手写编辑时，阅读性太差，不予考虑。 +不支持注释，手写编辑时，可读性太差，不予考虑。 -因此，我们选择了 Toml 作为默认的配置格式，并且解析后，缓存为 json 文件。SpaceVim -在启动时直接读取缓存的 json 文件，效率更高。 +因此，我们选择了 Toml 作为默认的配置格式，并且解析后缓存为 json 文件。 +SpaceVim 在启动时直接读取缓存的 json 文件，效率更高。 ### 为什么 SpaceVim 颜色主题和官网不一致？ -因为在 SpaceVim 中，默认情况下是启用了终端真色，因此你需要确保你的终端支持真色。 -但是并不是每种终端默认都支持真色的。因此，当你的终端不支持真色时， +因为在 SpaceVim 中，默认情况下启用了终端真色，因此你需要确保你的终端支持真色。 +但是并不是每种终端都支持真色。因此，当你的终端不支持真色时， 你可以在配置文件里面禁用真色支持： ```toml diff --git a/docs/cn/index.md b/docs/cn/index.md index 5374fc8fa..5cd4cc07f 100644 --- a/docs/cn/index.md +++ b/docs/cn/index.md @@ -1,6 +1,6 @@ --- -title: "主页" -description: "SpaceVim 是一个社区驱动的模块化 Vim IDE，以模块的方式组织和管理插件，提高 Vim 环境配置效率。" +title: "主页" +description: "SpaceVim 是一个社区驱动的模块化的 Vim IDE，以模块的方式组织和管理插件，提高 Vim 环境配置效率。" lang: cn --- @@ -13,15 +13,15 @@ lang: cn ![welcome-page](https://user-images.githubusercontent.com/13142418/50423286-5b33a400-088e-11e9-830c-792ce1c7c126.png) -# SpaceVim - 模块化 Vim IDE +# SpaceVim - 模块化的 Vim IDE -SpaceVim 是一个社区驱动的模块化 Vim IDE，以模块的方式组织管理插件以及相关配置， +SpaceVim 是一个社区驱动的模块化的 Vim IDE，以模块的方式组织管理插件以及相关配置， 为不同的语言开发量身定制了相关的开发模块，该模块提供代码自动补全， -语法检查、格式化、调试、REPL 等特性。用户仅需载入相关语言的模块即可得到一个开箱即用的Vim-IDE。 +语法检查、格式化、调试、REPL 等特性。用户仅需载入相关语言的模块即可得到一个开箱即用的 Vim IDE。 请查阅[《入门指南》](quick-start-guide/)、[《用户文档》](documentation/)和[《可用模块》](layers/)以获取更多信息。 -## 最新特新 +## 最新特性
      {% for post in site.categories.feature_cn offset: 0 limit: 5 %} @@ -39,7 +39,7 @@ SpaceVim 是一个社区驱动的模块化 Vim IDE，以模块的方式组织管 ## 参与 常规的项目讨论和问答主要是使用 [Gitter 聊天室](https://gitter.im/SpaceVim/cn) 和 [知乎](https://www.zhihu.com/topic/20168681/hot)， -而提交问题和贡献代码主要是在 [Github](https://github.com/SpaceVim/SpaceVim) 上。 +而提交问题和贡献代码主要是在 [Github](https://github.com/SpaceVim/SpaceVim) 上， 同时，SpaceVim 开通了[码云仓库](https://gitee.com/spacevim/SpaceVim)，主要用于中文交流。 ## 常见问题 @@ -49,13 +49,13 @@ SpaceVim 是一个社区驱动的模块化 Vim IDE，以模块的方式组织管 当前最新发布的稳定版本是 v1.0.0。可以查看 [时间表](https://github.com/SpaceVim/SpaceVim/milestones) 获取开发进度， 或者阅读 [Roadmap](roadmap/) 获取开发计划。 -- SpaceVim 是尝试搭建一个 IDE 吗? +- SpaceVim 是尝试搭建一个 IDE 吗？ 是的，通过模块的方式，将各种功能封装成相应的模块，对多种语言提供了语言开发模块，目标是尝试模拟简易的集成开发环境。 - SpaceVim 支持什么版本的 Vim/Neovim？ -建议使用 Vim7.4 或者 Neovim v0.1.7及其以上版本。 +建议使用 Vim 7.4 或者 Neovim v0.1.7及其以上版本。 更多常见问题请阅读 [《SpaceVim FAQ》](faq/) diff --git a/docs/cn/layers.md b/docs/cn/layers.md index 8a85231f7..6fc42f79a 100644 --- a/docs/cn/layers.md +++ b/docs/cn/layers.md @@ -1,7 +1,7 @@ --- -title: 可用模块 -description: "简述什么是模块，如何启用和禁用 SpaceVim 模块，以及如何设置模块选项。并罗列出 SpaceVim 中所有内置的模块。" -keywords: layer,layers +title: 可用模块 +description: "简述什么是模块，如何启用和禁用 SpaceVim 模块，以及如何设置模块选项，并罗列出 SpaceVim 中所有内置的模块。" +keywords: layer, layers lang: cn --- @@ -18,9 +18,9 @@ lang: cn ## 模块简介 -SpaceVim 是一个社区驱动的 vim 配置集合，通常一个 Vim 的配置集合包含了诸多的 +SpaceVim 是一个社区驱动的 Vim 配置集合，通常一个 Vim 的配置集合包含了诸多的 Vim 插件以及相关配置。而 SpaceVim 是以模块的方式来组织和管理这些插件以及相关 -的配置。默认情况下，这些模块都是禁用的，用户可以根据自己需要，或者是项目需要 +的配置。默认情况下，这些模块都是禁用的，用户可以根据自己需要或是项目需要 来载入指定的模块以获取相关功能。 通过模块的方式管理插件和相关配置，为使用者节省了大量的搜索插件和调试插件的时 @@ -29,7 +29,7 @@ Vim 插件以及相关配置。而 SpaceVim 是以模块的方式来组织和管 ### 启用模块 -以 `shell` 模块为例，启用该模块，并且设定一些模块选项，指定终端打开位置为 +以 `shell` 模块为例，启用该模块，并且通过设定一些模块选项，指定终端打开位置为 顶部，高度 30。 ```toml @@ -57,81 +57,82 @@ Vim 插件以及相关配置。而 SpaceVim 是以模块的方式来组织和管 ## 可用模块 -| 名称 | 描述 | -| ---------- | ------------ | -| [VersionControl](VersionControl/) | 这一模块为 SpaceVim 提供了通用的代码版本控制支持，该模块支持 Git、Mercurial、Bazaar、SVN 等等多种后台工具。 | -| [autocomplete](autocomplete/) | 这一模块为 SpaceVim 提供了自动补全的框架，包括语法补全等多种补全来源，同时提供了代码块自动完成等特性。 | -| [chat](chat/) | chat 模块为 SpaceVim 提供了一个聊天框架，目前支持微信聊天和 QQ 聊天，同时支持自定义聊天服务器。 | -| [checkers](checkers/) | 这一模块为 SpaceVim 提供了代码语法检查的特性，同时提供代码实时检查，并列出语法错误的位置 | -| [chinese](chinese/) | 该模块为中文用户提供了中文的 Vim 帮助文档，同时提供部分插件的中文帮助文档。 | -| [colorscheme](colorscheme/) | colorscheme 模块为 SpaceVim 提供了一系列的常用颜色主题，默认情况下使用深色 gruvbox 作为默认主题。该模块提供了快速切换主题、随即主题等特性 | -| [core#banner](core/banner/) | This layer provides many default banner on welcome page. | -| [core#statusline](core/statusline/) | 这一模块为 SpaceVim 提供了默认的模式化的状态了支持。 | -| [core#tabline](core/tabline/) | SpaceVim core#tabline layer provides a better tabline for SpaceVim | -| [core](core/) | core 模块主要包括 SpaceVim 启动及基本操作所必须的插件及配置。 | -| [cscope](cscope/) | cscope 模块为 SpaceVim 他提供了一个智能的 cscope 和 pycscope 辅助工具，可以快速调用 cscope 常用命令 | -| [ctrlp](ctrlp/) | 提供以 ctrlp 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 | -| [debug](debug/) | 这一模块为 SpaceVim 提供了 debug 的常用功能，采用 vebugger 作为后台框架，支持多种 debug 工具。 | -| [default](default/) | SpaceVim default 模块并不包含插件，但提供了一些更好的默认设置 | -| [denite](denite/) | 提供以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 | -| [edit](edit/) | 该模块提升了 SpaceVim 的文本编辑体验，提供更多种文本对象。 | -| [floobits](floobits/) | 该模块为 SpaceVim 提供了 floobits 协作工具的支持，实现多人协作编辑等功能。 | -| [format](format/) | 该模块为 SpaceVim 提供了代码异步格式化的功能，支持高度自定义配置和多种语言。 | -| [fzf](fzf/) | 提供以 fzf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 | -| [git](git/) | 这一模块为 SpaceVim 提供了 git 支持，根据当前 Vim 版本特性，选择 gina 或者 gita 作为默认的后台 git 插件。 | -| [github](github/) | 该模块主要提供了 Github 数据管理功能，包括问题列表、动态等管理。 | -| [japanese](japanese/) | 该模块为日文用户提供了日文的 Vim 帮助文档，同时提供部分插件的日文帮助文档。 | -| [lang#WebAssembly](lang/WebAssembly/) | 这一模块为 WebAssembly 开发提供支持。 | -| [lang#agda](lang/agda/) | 这一模块为 SpaceVim 提供了 agda 语言开发的支持，主要包括语法高亮及一键运行。 | -| [lang#asciidoc](lang/asciidoc/) | 这一模块为 asciidoc 编辑提供支持，包括格式化、自动生成文章目录、代码块等特性。 | -| [lang#autohotkey](lang/autohotkey/) | 这一个模块为 SpaceVim 提供了 autohotkey 语言的开发支持，包括语法高亮和自动补全等功能。 | -| [lang#c](lang/c/) | 这一模块为 c/c++/object-c 的开发提供了支持，包括代码补全、语法检查等特性。 | -| [lang#clojure](lang/clojure/) | 这一模块为 clojure 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#csharp](lang/csharp/) | 该模块为 SpaceVim 提供 csharp 开发支持，包括代码高亮、对齐、补全等特性。 | -| [lang#dart](lang/dart/) | 这一模块为 dart 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#dockerfile](lang/dockerfile/) | 这一模块为 dockerfile 的编辑提供了部分功能支持，包括语法高亮和自动补全。 | -| [lang#elixir](lang/elixir/) | 这一模块为 elixir 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#elm](lang/elm/) | 这一模块为 elm 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#erlang](lang/erlang/) | 这一模块为 erlang 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#extra](lang/extra/) | 该模块主要为一些不常见的语言添加语法支持，主要包括语法高亮、对齐等特性 | -| [lang#fsharp](lang/fsharp/) | 这一模块为 fsharp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#go](lang/go/) | 这一模块为 go 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#haskell](lang/haskell/) | 这一模块为 haskell 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#html](lang/html/) | 这一模块为 html 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#java](lang/java/) | 这一模块为 java 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#javascript](lang/javascript/) | 这一模块为 javascript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#julia](lang/julia/) | 这一模块为 julia 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#kotlin](lang/kotlin/) | 该模块为 SpaceVim 提供了 kotlin 语言开发支持，包括语法高亮、语言服务器支持。 | -| [lang#latex](lang/latex/) | 这一模块为 latex 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#lisp](lang/lisp/) | 这一模块为 lisp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#lua](lang/lua/) | 这一模块为 lua 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#markdown](lang/markdown/) | 这一模块为 markdown 编辑提供支持，包括格式化、自动生成文章目录、代码块等特性。 | -| [lang#nim](lang/nim/) | 该模块为 SpaceVim 提供 nim 开发支持，包括语法高亮、代码补全、编译运行以及交互式编程等功能。 | -| [lang#ocaml](lang/ocaml/) | 这一模块为 ocaml 开发提供了支持，包括语法高亮、代码补全、以及定义处跳转等功能。 | -| [lang#perl](lang/perl/) | 这一模块为 perl 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#php](lang/php/) | 这一模块为 php 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#plantuml](lang/plantuml/) | 这一模块为 plantuml 开发提供支持，包括语法高亮、实时预览等特性。 | -| [lang#puppet](lang/puppet/) | 该模块为 SpaceVim 提供了 puppet 语言开发支持，包括语法高亮、语言服务器支持。 | -| [lang#purescript](lang/purescript/) | 这一模块为 purescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#python](lang/python/) | 这一模块为 python 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#ruby](lang/ruby/) | 这一模块为 ruby 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#rust](lang/rust/) | 这一模块为 rust 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#scala](lang/scala/) | 这一模块为 scala 开发提供支持，包括语法高亮，函数列表等特性 | -| [lang#scheme](lang/scheme/) | 该模块为 SpaceVim 提供了 scheme 语言开发支持，包括语法高亮、语言服务器支持。 | -| [lang#sh](lang/sh/) | 这一模块为 shell script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#swift](lang/swift/) | 该模块主要为 SpaceVim 提供了 swift 开发支持，包括语法高亮、语法检查等特性。 | -| [lang#typescript](lang/typescript/) | 这一模块为 typescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#vim](lang/vim/) | 这一模块为 vim script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lang#vue](lang/vue/) | 这一模块为 vue 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 | -| [lsp](language-server-protocol/) | lsp 模块为 SpaceVim 提供 language server protocol 的支持，提供更多语言相关服务 | -| [leaderf](leaderf/) | 提供以 leaderf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。 | -| [shell](shell/) | 这一模块为 SpaceVim 提供了终端集成特性，优化内置终端的使用体验 | -| [sudo](sudo/) | sudo 提供了在 SpaceVim 中以管理员身份读写文件的功能。 | -| [tags](tags/) | tags 模块提供全局的 tags 索引管理，提供快速检索定义和引用的功能。 | -| [tmux](tmux/) | 该模块主要提供了一些在 Vim 内操作 tmux 的功能，使得在 tmux 窗口之间跳转更加便捷。 | -| [tools#dash](tools/dash/) | 该模块提供对 Dash 支持，可快速查找光标位置的单词 | -| [tools](tools/) | 集成多种常用工具，包括日历、计算器、等等多种工具类插件，该模块针对 vim8 以及 neovim 提供了更好的插件选择。 | -| [ui](ui/) | SpaceVim ui 模块提供了一个 IDE-like 的界面，包括状态栏、文件树、语法数等等特性。 | +| 名称 | 描述 | +| ------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| [autocomplete](autocomplete/) | 这一模块为 SpaceVim 提供了自动补全的框架，包括语法补全等多种补全来源，同时提供了代码块自动完成等特性。 | +| [chat](chat/) | 这一模块为 SpaceVim 提供了一个聊天框架，目前支持微信聊天和 QQ 聊天，同时支持自定义聊天服务器。 | +| [checkers](checkers/) | 这一模块为 SpaceVim 提供了代码语法检查的特性，同时提供代码实时检查，并列出语法错误的位置。 | +| [chinese](chinese/) | 这一模块为 SpaceVim 的中文用户提供了中文的 Vim 帮助文档，同时提供部分插件的中文帮助文档。 | +| [colorscheme](colorscheme/) | 这一模块为 SpaceVim 提供了一系列的常用颜色主题，默认情况下使用深色 gruvbox 作为默认主题。该模块提供了快速切换主题、随机主题等特性。 | +| [core#banner](core/banner/) | 这一模块为 SpaceVim 提供了许多可以默认显示在首页的 Logo。 | +| [core#statusline](core/statusline/) | 这一模块为 SpaceVim 提供了默认的模式化的状态栏支持。 | +| [core#tabline](core/tabline/) | 这一模块为 SpaceVim 提供了一个更好的标签栏。 | +| [core](core/) | 这一模块为 SpaceVim 提供了启动及基本操作所必须的插件及配置。 | +| [cscope](cscope/) | 这一模块为 SpaceVim 提供了一个智能的 cscope 和 pycscope 辅助工具，可以快速调用 cscope 常用命令。 | +| [ctrlp](ctrlp/) | 这一模块为 SpaceVim 提供以 ctrlp 为核心的模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。 | +| [debug](debug/) | 这一模块为 SpaceVim 提供了 debug 的常用功能，采用 vebugger 作为后台框架，支持多种 debug 工具。 | +| [default](default/) | 这一模块未为 SpaceVim 提供任何插件，但提供了一些更好的默认设置。 | +| [denite](denite/) | 这一模块为 SpaceVim 提供了以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。 | +| [edit](edit/) | 这一模块为 SpaceVim 提供了更好的文本编辑体验，提供更多种文本对象。 | +| [floobits](floobits/) | 这一模块为 SpaceVim 提供了 floobits 协作工具的支持，实现多人协作编辑等功能。 | +| [format](format/) | 这一模块为 SpaceVim 提供了代码异步格式化功能，支持高度自定义配置和多种语言。 | +| [fzf](fzf/) | 这一模块为 SpaceVim 提供了以 fzf 为核心的异步模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。 | +| [git](git/) | 这一模块为 SpaceVim 提供了 Git 支持，根据当前 Vim 版本特性，选择 gina 或者 gita 作为默认的后台 Git 插件。 | +| [github](github/) | 这一模块为 SpaceVim 提供了 Github 数据管理功能，包括问题列表、动态等管理。 | +| [japanese](japanese/) | 这一模块为 SpaceVim 的日文用户提供了日文的 Vim 帮助文档，同时提供部分插件的日文帮助文档。 | +| [lang#agda](lang/agda/) | 这一模块为 SpaceVim 提供了 Agda 的开发支持，主要包括语法高亮及一键运行。 | +| [lang#asciidoc](lang/asciidoc/) | 这一模块为 SpaceVim 提供了 AsciiDoc 的编辑支持，包括格式化、自动生成文章目录、代码块等特性。 | +| [lang#autohotkey](lang/autohotkey/) | 这一模块为 SpaceVim 提供了 Autohotkey 的开发支持，包括语法高亮和自动补全等功能。 | +| [lang#c](lang/c/) | 这一模块为 SpaceVim 提供了 C/C++/Object-C 的开发支持，包括代码补全、语法检查等特性。 | +| [lang#clojure](lang/clojure/) | 这一模块为 SpaceVim 提供了 Clojure 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#csharp](lang/csharp/) | 这一模块为 SpaceVim 提供了 CSharp 的开发支持，包括代码高亮、对齐、补全等特性。 | +| [lang#dart](lang/dart/) | 这一模块为 SpaceVim 提供了 Dart 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#dockerfile](lang/dockerfile/) | 这一模块为 SpaceVim 提供了 Dockerfile 编辑的部分功能支持，包括语法高亮和自动补全。 | +| [lang#elixir](lang/elixir/) | 这一模块为 SpaceVim 提供了 Elixir 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#elm](lang/elm/) | 这一模块为 SpaceVim 提供了 Elm 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#erlang](lang/erlang/) | 这一模块为 SpaceVim 提供了 Erlang 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#extra](lang/extra/) | 这一模块为 SpaceVim 提供了一些不常见的语言的语法支持，主要包括语法高亮、对齐等特性。 | +| [lang#fsharp](lang/fsharp/) | 这一模块为 SpaceVim 提供了 FSharp 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#go](lang/go/) | 这一模块为 SpaceVim 提供了 Go 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#haskell](lang/haskell/) | 这一模块为 SpaceVim 提供了 Haskell 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#html](lang/html/) | 这一模块为 SpaceVim 提供了 HTML 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#java](lang/java/) | 这一模块为 SpaceVim 提供了 Java 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#javascript](lang/javascript/) | 这一模块为 SpaceVim 提供了 JavaScript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#julia](lang/julia/) | 这一模块为 SpaceVim 提供了 Julia 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#kotlin](lang/kotlin/) | 这一模块为 SpaceVim 提供了 kotlin 的开发支持，包括语法高亮、语言服务器支持。 | +| [lang#latex](lang/latex/) | 这一模块为 SpaceVim 提供了 LaTeX 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#lisp](lang/lisp/) | 这一模块为 SpaceVim 提供了 LISP 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#lua](lang/lua/) | 这一模块为 SpaceVim 提供了 Lua 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#markdown](lang/markdown/) | 这一模块为 SpaceVim 提供了 Markdown 编辑支持，包括格式化、自动生成文档目录、代码块等特性。 | +| [lang#nim](lang/nim/) | 这一模块为 SpaceVim 提供了 Nim 的开发支持，包括语法高亮、代码补全、编译运行以及交互式编程等功能。 | +| [lang#ocaml](lang/ocaml/) | 这一模块为 SpaceVim 提供了 OCaml 开发提供了支持，包括语法高亮、代码补全、以及定义处跳转等功能。 | +| [lang#perl](lang/perl/) | 这一模块为 SpaceVim 提供了 Perl 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#php](lang/php/) | 这一模块为 SpaceVim 提供了 PHP 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#plantuml](lang/plantuml/) | 这一模块为 SpaceVim 提供了 PlantUML 的开发支持，包括语法高亮、实时预览等特性。 | +| [lang#puppet](lang/puppet/) | 这一模块为 SpaceVim 提供了 Puppet 的开发支持，包括语法高亮、语言服务器支持。 | +| [lang#purescript](lang/purescript/) | 这一模块为 SpaceVim 提供了 PureScript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#python](lang/python/) | 这一模块为 SpaceVim 提供了 Python 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#ruby](lang/ruby/) | 这一模块为 SpaceVim 提供了 Ruby 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#rust](lang/rust/) | 这一模块为 SpaceVim 提供了 Rust 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#scala](lang/scala/) | 这一模块为 SpaceVim 提供了 Scala 的开发支持，包括语法高亮，函数列表等特性 | +| [lang#scheme](lang/scheme/) | 这一模块为 SpaceVim 提供了 Scheme 语言开发支持，包括语法高亮、语言服务器支持。 | +| [lang#sh](lang/sh/) | 这一模块为 SpaceVim 提供了 Shell Script 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#swift](lang/swift/) | 这一模块为 SpaceVim 提供了 Swift 的开发支持，包括语法高亮、语法检查等特性。 | +| [lang#typescript](lang/typescript/) | 这一模块为 SpaceVim 提供了 Typescript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#vim](lang/vim/) | 这一模块为 SpaceVim 提供了 Vimscript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#vue](lang/vue/) | 这一模块为 SpaceVim 提供了 Vue 的的开发支持，包括代码补全、语法检查、代码格式化等特性。 | +| [lang#WebAssembly](lang/WebAssembly/) | 这一模块为 SpaceVim 提供了 WebAssembly 的开发支持。 | +| [leaderf](leaderf/) | 这一模块为 SpaceVim 提供了以 leaderf 为核心的异步模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。 | +| [lsp](language-server-protocol/) | 这一模块为 SpaceVim 提供了 language server protocol 的支持，提供更多语言相关服务。 | +| [shell](shell/) | 这一模块为 SpaceVim 提供了终端集成特性，优化内置终端的使用体验。 | +| [sudo](sudo/) | 这一模块为 SpaceVim 提供了以管理员身份读写文件的功能。 | +| [tags](tags/) | 这一模块为 SpaceVim 提供了全局的 tags 索引管理，提供快速检索定义和引用的功能。 | +| [tmux](tmux/) | 这一模块为 SpaceVim 提供了一些在 Vim 内操作 tmux 的功能，使得在 tmux 窗口之间跳转更加便捷。 | +| [tools#dash](tools/dash/) | 这一模块为 SpaceVim 提供了 Dash 支持，可快速查找光标位置的单词。 | +| [tools](tools/) | 这一模块为 SpaceVim 提供了多种常用工具，包括日历、计算器等多种工具类插件，并针对 Vim8 以及 Neovim 提供了更好的插件选择。 | +| [ui](ui/) | 这一模块为 SpaceVim 提供了 IDE-like 的界面，包括状态栏、文件树、语法树等等特性。 | +| [VersionControl](VersionControl/) | 这一模块为 SpaceVim 提供了通用的代码版本控制支持，该模块支持 Git、Mercurial、Bazaar、SVN 等等多种后台工具。 | + diff --git a/docs/cn/layers/autocomplete.md b/docs/cn/layers/autocomplete.md index 7c5742cba..f9c820d7e 100644 --- a/docs/cn/layers/autocomplete.md +++ b/docs/cn/layers/autocomplete.md @@ -49,12 +49,12 @@ SpaceVim 选项 `snippet_engien` 设置为 ultisnips 为了提升用户体验，可以通过使用如下的模块选项来定制自动补全： 1. `auto-completion-return-key-behavior` 选项控制当按下 `Return`/`Enter` 键时的行为， - 默认为 `complete`，可用的值包括如下3种： + 默认为 `complete`，可用的值包括如下 3 种： - `complete` 补全模式，插入当前选中的列表选项 - `smart` 智能模式，插入当前选中的列表选项，若当前选择的时 snippet，则自动展开代码块。 - `nil` 当设为 nil 时，则采用 Vim 默认的按键行为，插入新行 2. `auto-completion-tab-key-behavior` 选项控制当按下 `Tab` 键时的行为，默认为 - `complete`，可用的值包括如下4种： + `complete`，可用的值包括如下 4 种： - `smart` 智能模式，自动循环补全列表、展开代码块以及跳至下一个代码块的锚点 - `complete` 补全模式，插入当前选中的列表选项 - `cycle` 循环模式，自动再补全列表之间循环 diff --git a/docs/cn/layers/chat.md b/docs/cn/layers/chat.md index 53c7243c2..e60a37c29 100644 --- a/docs/cn/layers/chat.md +++ b/docs/cn/layers/chat.md @@ -1,6 +1,7 @@ --- title: "SpaceVim chat 模块" -description: "chat 模块为 SpaceVim 提供了一个聊天框架，目前支持微信聊天和 QQ 聊天，同时支持自定义聊天服务器。" +description: "这一模块为 SpaceVim 提供了一个聊天框架，目前支持微信聊天和 QQ 聊天，同时支持自定义聊天服务器。" +lang: cn --- # [可用模块](../) >> chat diff --git a/docs/cn/layers/checkers.md b/docs/cn/layers/checkers.md index 1bb6fce39..3d12a9c14 100644 --- a/docs/cn/layers/checkers.md +++ b/docs/cn/layers/checkers.md @@ -1,6 +1,6 @@ --- title: "SpaceVim checkers 模块" -description: "这一模块为 SpaceVim 提供了代码语法检查的特性，同时提供代码实时检查，并列出语法错误的位置" +description: "这一模块为 SpaceVim 提供了代码语法检查的特性，同时提供代码实时检查，并列出语法错误的位置。" lang: cn --- diff --git a/docs/cn/layers/chinese.md b/docs/cn/layers/chinese.md index b036d9279..e7d1cee7d 100644 --- a/docs/cn/layers/chinese.md +++ b/docs/cn/layers/chinese.md @@ -1,6 +1,6 @@ --- title: "SpaceVim chinese 模块" -description: "该模块为中文用户提供了中文的 Vim 帮助文档，同时为部分插件提供了中文帮助文档。" +description: "这一模块为 SpaceVim 的中文用户提供了中文的 Vim 帮助文档，同时提供部分插件的中文帮助文档。" lang: cn --- diff --git a/docs/cn/layers/colorscheme.md b/docs/cn/layers/colorscheme.md index 7883c8a03..1465aa42b 100644 --- a/docs/cn/layers/colorscheme.md +++ b/docs/cn/layers/colorscheme.md @@ -1,6 +1,7 @@ --- + title: "SpaceVim colorscheme 模块" -description: "colorscheme 模块为 SpaceVim 提供了一系列的常用颜色主题，默认情况下使用深色 gruvbox 作为默认主题。该模块提供了快速切换主题、随即主题等特性" +description: "这一模块为 SpaceVim 提供了一系列的常用颜色主题，默认情况下使用深色 gruvbox 作为默认主题。该模块提供了快速切换主题、随机主题等特性。" lang: cn --- diff --git a/docs/cn/layers/core.md b/docs/cn/layers/core.md index a0855dc8a..c85c40c18 100644 --- a/docs/cn/layers/core.md +++ b/docs/cn/layers/core.md @@ -1,6 +1,6 @@ --- title: "SpaceVim core 模块" -description: "core 模块主要包括 SpaceVim 启动及基本操作所必须的插件及配置。" +description: "这一模块为 SpaceVim 提供了启动及基本操作所必须的插件及配置。" lang: cn --- diff --git a/docs/cn/layers/core/banner.md b/docs/cn/layers/core/banner.md index 21f3f0d27..5487bc7af 100644 --- a/docs/cn/layers/core/banner.md +++ b/docs/cn/layers/core/banner.md @@ -1,6 +1,6 @@ --- title: "SpaceVim core#banner 模块" -description: "This layer provides many default banner on welcome page." +description: "这一模块为 SpaceVim 提供了许多显示在启动界面的 Logo。" lang: cn --- @@ -15,11 +15,11 @@ lang: cn ## 模块简介 -这一模块主要是为 SpaceVim 设置一些默认的启动界面的 logo。 +这一模块主要是为 SpaceVim 设置一些默认的启动界面的 Logo。 ## 模块选项 -- frequece for change the banner: daily, weekly, or other. +- 修改 banner 切换的频率：daily, weekly, or other. diff --git a/docs/cn/layers/core/statusline.md b/docs/cn/layers/core/statusline.md index 5d07207d8..8bc2085ef 100644 --- a/docs/cn/layers/core/statusline.md +++ b/docs/cn/layers/core/statusline.md @@ -29,5 +29,7 @@ lang: cn ## 相关选项 -在这里，将列出一些跟状态了相关的 SpaceVim 相关选项，这些选项并非模块选项，需加以区分： +在这里，将列出一些跟状态栏相关的 SpaceVim 相关选项，这些选项并非模块选项，需加以区分： + +TODO diff --git a/docs/cn/layers/core/tabline.md b/docs/cn/layers/core/tabline.md index 018e63c79..867df4da8 100644 --- a/docs/cn/layers/core/tabline.md +++ b/docs/cn/layers/core/tabline.md @@ -1,11 +1,11 @@ --- title: "SpaceVim core#tabline 模块" -description: "SpaceVim core#tabline layer provides a better tabline for SpaceVim" +description: "这一模块为 SpaceVim 提供了更好的标签栏。" lang: cn --- # [可用模块](../) >> core#tabline - + - [模块简介](#模块简介) @@ -22,10 +22,10 @@ lang: cn ## 相关选项 -以下均为 SpaceVim 选项，不同于模块选项，需要写在 `[options]` 下面： +以下均为 SpaceVim 选项，不同于模块选项，这些选项需要写在 `[options]` 下面： - `enable_tabline_filetype_icon`：展示或者隐藏标签栏上的文件类型图标，需要安装 nerd 字体。默认开启的， -若需要禁用，可将其值设为 `false` +若需要禁用，可将其值设为 `false`。 ```toml [options] @@ -34,4 +34,4 @@ lang: cn ## 快捷键 -所有的标签栏相关的快捷键可以在[《使用文档》](../../../documentation/#标签栏)中查询到。 +所有与标签栏相关的快捷键可以在[《使用文档》](../../../documentation/#标签栏)中查询到。 diff --git a/docs/cn/layers/cscope.md b/docs/cn/layers/cscope.md index f4f886e96..876685d4f 100644 --- a/docs/cn/layers/cscope.md +++ b/docs/cn/layers/cscope.md @@ -1,6 +1,6 @@ --- title: "SpaceVim cscope 模块" -description: "cscope 模块为 SpaceVim 他提供了一个智能的 cscope 和 pycscope 辅助工具，可以快速调用 cscope 常用命令" +description: "这一模块为 SpaceVim 提供了一个智能的 cscope 和 pycscope 辅助工具，可以快速调用 cscope 常用命令。" lang: cn --- @@ -25,8 +25,8 @@ lang: cn ## 模块特性 -- 通过 cscope 为 c 和 c++ 建立索引，并提供查询功能 -- 通过 Pycscope 为 python 建立索引，并提供查询功能 +- 通过 cscope 为 C 和 C++ 建立索引，并提供查询功能 +- 通过 Pycscope 为 Python 建立索引，并提供查询功能 ## 安装依赖及启用模块 diff --git a/docs/cn/layers/ctrlp.md b/docs/cn/layers/ctrlp.md index b5eb370b7..c76a764b3 100644 --- a/docs/cn/layers/ctrlp.md +++ b/docs/cn/layers/ctrlp.md @@ -1,6 +1,6 @@ --- title: "SpaceVim ctrlp 模块" -description: "提供以 ctrlp 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。" +description: "这一模块为 SpaceVim 提供以 ctrlp 为核心的模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。" lang: cn --- @@ -17,7 +17,7 @@ lang: cn ## 模块介绍 -这一模块在 ctrlp 的基础上做了时当的包装和定制，提供了搜索文件、函数列表、 +这一模块在 ctrlp 的基础上做了适当的包装和定制，提供了搜索文件、函数列表、 命令历史等等特性。 ## 启用模块 diff --git a/docs/cn/layers/debug.md b/docs/cn/layers/debug.md index 45ee1bc62..1a144834c 100644 --- a/docs/cn/layers/debug.md +++ b/docs/cn/layers/debug.md @@ -1,6 +1,6 @@ --- title: "SpaceVim debug 模块" -description: "这一模块为 SpaceVim 提供了 debug 的常用功能，采用 vebugger 作为后台框架，支持多种 debug 工具。" +description: "这一模块为 SpaceVim 提供了 Debug 的常用功能，采用 vebugger 作为后台框架，支持多种 Debug 工具。" lang: cn --- @@ -16,8 +16,8 @@ lang: cn ## 模块描述 -这一模块为 SpaceVim 提供了基本的 debug 框架，高度定制 -[vim-vebugger](https://github.com/idanarye/vim-vebugger) 插件，支持多种 debug +这一模块为 SpaceVim 提供了基本的 Debug 框架，高度定制 +[vim-vebugger](https://github.com/idanarye/vim-vebugger) 插件，支持多种 Debug 工具。 ## 启用模块 @@ -31,22 +31,22 @@ SpaceVim 默认未载入该模块，如需载入模块，可以在配置文件 ## 快捷键 -| 按键 | 描述 | -| ----------- | ------------------------- | -| `SPC d l` | 启动 debugger | -| `SPC d c` | 继续下一步 | -| `SPC d b` | 添加/去除当前行断点 | -| `SPC d B` | 清除所有断点 | -| `SPC d o` | 单步执行 | -| `SPC d i` | 跳至方法体 | -| `SPC d O` | 运行至当前方法结束 | -| `SPC d e s` | 打印并求值选中的文本 | -| `SPC d e e` | 打印并求值光标所在变量 | -| `SPC d e S` | Execute the selected text | -| `SPC d k` | 关闭 debugger | +| 按键 | 描述 | +| ----------- | ---------------------- | +| `SPC d l` | 启动 debugger | +| `SPC d c` | 继续下一步 | +| `SPC d b` | 添加/去除当前行断点 | +| `SPC d B` | 清除所有断点 | +| `SPC d o` | 单步执行 | +| `SPC d i` | 跳至方法体 | +| `SPC d O` | 运行至当前方法结束 | +| `SPC d e s` | 打印并求值选中的文本 | +| `SPC d e e` | 打印并求值光标所在变量 | +| `SPC d e S` | 执行选中的文本 | +| `SPC d k` | 关闭 debugger | **Debug 临时快捷键菜单** -debug 的快捷键太长了？ 可以使用 `SPC d .` 调出 debug 临时快捷键菜单。 +Debug 的快捷键太长了？可以使用 `SPC d .` 调出 Debug 临时快捷键菜单。 ![Debug Transient State](https://user-images.githubusercontent.com/13142418/33996076-b03c05bc-e0a5-11e7-90fd-5f31e2703d7e.png) diff --git a/docs/cn/layers/default.md b/docs/cn/layers/default.md index d38019bdb..b6ced732d 100644 --- a/docs/cn/layers/default.md +++ b/docs/cn/layers/default.md @@ -1,6 +1,6 @@ --- title: "SpaceVim default 模块" -description: "SpaceVim default 模块并不包含插件，但提供了一些更好的默认设置" +description: "这一模块未为 SpaceVim 提供任何插件，但提供了一些更好的默认设置。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块描述 -这一模块主要优化了一些 Vim 设置，包含了一些默认的设置选项，和快捷键。 +这一模块主要优化了一些 Vim 设置，包含了一些默认的设置选项和快捷键。 ## 启用模块 diff --git a/docs/cn/layers/denite.md b/docs/cn/layers/denite.md index 343b285ce..d5a70c2c9 100644 --- a/docs/cn/layers/denite.md +++ b/docs/cn/layers/denite.md @@ -1,6 +1,6 @@ --- title: "SpaceVim denite 模块" -description: "提供以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。" +description: "这一模块为 SpaceVim 提供了以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。" lang: cn --- @@ -16,9 +16,7 @@ lang: cn ## 模块描述 -提供以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。这一模块需要 Vim -或者 Neovim 支持 `+python3`。 - +提供以 denite 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。这一模块需要 Vim/Neovim 支持 `+python3`。 ## 启用模块 denite 模块默认并为启用，如果需要启用该模块，需要在配置文件里面加入： diff --git a/docs/cn/layers/edit.md b/docs/cn/layers/edit.md index 4d63156bb..86c3a6fe5 100644 --- a/docs/cn/layers/edit.md +++ b/docs/cn/layers/edit.md @@ -1,6 +1,6 @@ --- title: "SpaceVim edit 模块" -description: "该模块提升了 SpaceVim 的文本编辑体验，提供更多种文本对象。" +description: "这一模块为 SpaceVim 提供了更好的文本编辑体验，提供更多种文本对象。" lang: cn --- @@ -27,16 +27,17 @@ lang: cn - 对齐文档内容 - 高亮行为符号 - 自动载入 editorconfig 配置，需要 `+python` 或者 `+python3` 支持 +- 默认已启用 ## 模块选项 -- `textobj`: specified a list of text opjects to be enabled, the avaliable list is :`indent`, `line`, `entire` +- `textobj`: specified a list of text opjects to be enabled, the avaliable list is: `indent`, `line`, `entire` ## 快捷键 -快捷键 | 功能描述 ---- | --- -`SPC x a {分隔符}` | 基于分隔符进行文本对齐 +| 快捷键 | 功能描述 | +| ------------------ | ---------------------- | +| `SPC x a {分隔符}` | 基于分隔符进行文本对齐 | **默认的分隔符：** diff --git a/docs/cn/layers/floobits.md b/docs/cn/layers/floobits.md index 1b6c55f2e..e35d1c192 100644 --- a/docs/cn/layers/floobits.md +++ b/docs/cn/layers/floobits.md @@ -1,6 +1,6 @@ --- title: "SpaceVim floobits 模块" -description: "该模块为 SpaceVim 提供了 floobits 协作工具的支持，实现多人协作编辑等功能。" +description: "这一模块为 SpaceVim 提供了 floobits 协作工具的支持，实现多人协作编辑等功能。" lang: cn --- @@ -17,7 +17,7 @@ lang: cn ## 模块简介 -该模块为 SpaceVim 提供了多人协作工具 floobits 的支持，该模块目前仅支持在 neovim 下正常工作。 +该模块为 SpaceVim 提供了多人协作工具 floobits 的支持，该模块目前仅支持在 Neovim 下正常工作。 ## 功能特性 @@ -38,7 +38,7 @@ lang: cn ## 快捷键 -| 按键 | 功能描述 | +| 按键 | 功能描述 | | ------------ | --------------------------------------------------------- | | `SPC m f j` | Join workspace | | `SPC m f t` | Toggle follow mode | diff --git a/docs/cn/layers/format.md b/docs/cn/layers/format.md index f074c0539..cc5835b9f 100644 --- a/docs/cn/layers/format.md +++ b/docs/cn/layers/format.md @@ -1,6 +1,6 @@ --- title: "SpaceVim format 模块" -description: "该模块为 SpaceVim 提供了代码异步格式化的功能，支持高度自定义配置和多种语言。" +description: "这一模块为 SpaceVim 提供了代码异步格式化功能，支持高度自定义配置和多种语言。" lang: cn --- diff --git a/docs/cn/layers/fzf.md b/docs/cn/layers/fzf.md index 04cfd6c72..063ff8cdc 100644 --- a/docs/cn/layers/fzf.md +++ b/docs/cn/layers/fzf.md @@ -1,6 +1,6 @@ --- title: "SpaceVim fzf 模块" -description: "提供以 fzf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。" +description: "这一模块为 SpaceVim 提供了以 fzf 为核心的异步模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块介绍 -这一模块在 fzf 的基础上做了时当的包装和定制，提供了搜索文件、函数列表、 +这一模块在 fzf 的基础上做了适当的包装和定制，提供了搜索文件、函数列表、 命令历史等等特性。 ## 启用模块 diff --git a/docs/cn/layers/git.md b/docs/cn/layers/git.md index fe1dd4ff8..1a8e2a89e 100644 --- a/docs/cn/layers/git.md +++ b/docs/cn/layers/git.md @@ -1,6 +1,6 @@ --- title: "SpaceVim git 模块" -description: "这一模块为 SpaceVim 提供了 git 支持，根据当前 Vim 版本特性，选择 gina 或者 gita 作为默认的后台 git 插件。" +description: "这一模块为 SpaceVim 提供了 Git 支持，根据当前 Vim 版本特性，选择 gina 或者 gita 作为默认的后台 Git 插件。" lang: cn --- diff --git a/docs/cn/layers/github.md b/docs/cn/layers/github.md index f13939997..f319b7fe6 100644 --- a/docs/cn/layers/github.md +++ b/docs/cn/layers/github.md @@ -1,6 +1,6 @@ --- title: "SpaceVim github 模块" -description: "该模块主要提供了 Github 数据管理功能，包括问题列表、动态等管理。" +description: "这一模块为 SpaceVim 提供了 Github 数据管理功能，包括问题列表、动态等管理。" lang: cn --- diff --git a/docs/cn/layers/japanese.md b/docs/cn/layers/japanese.md index a77cae47d..93949b9b9 100644 --- a/docs/cn/layers/japanese.md +++ b/docs/cn/layers/japanese.md @@ -1,6 +1,6 @@ --- title: "SpaceVim japanese 模块" -description: "该模块为日文用户提供了日文的 Vim 帮助文档，同时提供部分插件的日文帮助文档。" +description: "这一模块为 SpaceVim 的日文用户提供了日文的 Vim 帮助文档，同时提供部分插件的日文帮助文档。" lang: cn --- @@ -29,7 +29,7 @@ lang: cn ## 模块配置 -加在该模块后，默认的帮助文件语言并为设置为日文，可以通过 SpaceVim 选项 +加载该模块后，默认的帮助文件语言并未设置为日文，可以通过 SpaceVim 选项 `vim_help_language` 来设置，可将其值设为 `"jp"`。 ```toml diff --git a/docs/cn/layers/lang/WebAssembly.md b/docs/cn/layers/lang/WebAssembly.md index 897545eb8..ca972c000 100644 --- a/docs/cn/layers/lang/WebAssembly.md +++ b/docs/cn/layers/lang/WebAssembly.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#WebAssembly 模块" -description: "这一模块为 WebAssembly 开发提供支持。" +description: "这一模块为 SpaceVim 提供了 WebAssembly 的开发支持。" lang: cn --- @@ -15,7 +15,7 @@ lang: cn ## 模块简介 -`lang#WebAssembly` 模块提供了 WebAssembly 语法高亮，采用 [vim-wasm](https://github.com/rhysd/vim-wasm) 这一插件。 +这一模块为 SpaceVim 提供了 WebAssembly 的开发支持。采用 [vim-wasm](https://github.com/rhysd/vim-wasm) 这一插件。 ## 启用模块 diff --git a/docs/cn/layers/lang/agda.md b/docs/cn/layers/lang/agda.md index 8e408f1a2..f4137b254 100644 --- a/docs/cn/layers/lang/agda.md +++ b/docs/cn/layers/lang/agda.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#agda 模块" -description: "这一模块为 SpaceVim 提供了 agda 语言开发的支持，主要包括语法高亮及一键运行。" +description: "这一模块为 SpaceVim 提供了 Agda 的开发支持，主要包括语法高亮及一键运行。" lang: cn --- @@ -17,7 +17,7 @@ lang: cn ## 模块简介 -Agda是一种依赖类型的函数式编程语言。这一模块为 SpaceVim 提供了 [agda](https://github.com/agda/agda) 开发支持。 +Agda 是一种依赖类型的函数式编程语言。这一模块为 SpaceVim 提供了 [agda](https://github.com/agda/agda) 开发支持。 ## 功能特性 diff --git a/docs/cn/layers/lang/asciidoc.md b/docs/cn/layers/lang/asciidoc.md index d8135958d..947399a26 100644 --- a/docs/cn/layers/lang/asciidoc.md +++ b/docs/cn/layers/lang/asciidoc.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#asciidoc layer" -description: "这一模块为 asciidoc 编辑提供支持，包括格式化、自动生成文章目录、代码块等特性。" +description: "这一模块为 SpaceVim 提供了 AsciiDoc 的编辑支持，包括格式化、自动生成文章目录、代码块等特性。" lang: cn --- @@ -15,7 +15,7 @@ lang: cn ## 模块简介 -该模块为 SpaceVim 提供了 asciidoc 文件夹编辑支持。该模块包括以下插件： +这一模块为 SpaceVim 提供了 AsciiDoc 的编辑支持，包括格式化、自动生成文章目录、代码块等特性。该模块包括以下插件： - `wsdjeg/vim-asciidoc` - `Raimondi/VimRegStyle` diff --git a/docs/cn/layers/lang/autohotkey.md b/docs/cn/layers/lang/autohotkey.md index 3d7e6c7d0..b56e3ef25 100644 --- a/docs/cn/layers/lang/autohotkey.md +++ b/docs/cn/layers/lang/autohotkey.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#autohotkey 模块" -description: "这一个模块为 SpaceVim 提供了 autohotkey 语言的开发支持，包括语法高亮和自动补全等功能。" +description: "这一模块为 SpaceVim 提供了 Autohotkey 的开发支持，包括语法高亮和自动补全等功能。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块简介 -这一个模块为 SpaceVim 提供了 autohotkey 语言的开发支持。 +这一个模块为 SpaceVim 提供了 Autohotkey 语言的开发支持。 ## 功能特性 diff --git a/docs/cn/layers/lang/c.md b/docs/cn/layers/lang/c.md index abe84fa8c..b6364972a 100644 --- a/docs/cn/layers/lang/c.md +++ b/docs/cn/layers/lang/c.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#c 模块" -description: "这一模块为 c/c++/object-c 的开发提供了支持，包括代码补全、语法检查等特性。" +description: "这一模块为 SpaceVim 提供了 C/C++/Object-C 的开发支持，包括代码补全、语法检查等特性。" lang: cn --- @@ -18,7 +18,7 @@ lang: cn ## 模块简介 -这一模块为 c/c++/object-c 的开发提供了支持，包块代码补全、语法检查、格式化等特性。 +这一模块为 SpaceVim 提供了 C/C++/Object-C 的开发支持，包括代码补全、语法检查等特性。 ## 启用模块 @@ -37,17 +37,17 @@ lang: cn ## 模块配置 -- `clang_executable` （字符串） +- `clang_executable`（字符串） 设置可执行程序 clang 的路径。 -- `libclang_path` （字符串） +- `libclang_path`（字符串） 设置 libclang 的路径，默认情况下该选项值为空。 -- `clang_std` （字典） +- `clang_std`（字典） -该字典存储编辑不同 c 家族文件类型时所使用的标准库。默认值为： +该字典存储编辑不同 C 家族文件类型时所使用的标准库。默认值为： ```json { @@ -61,7 +61,7 @@ lang: cn - `clang_flag` 通常，在项目根目录新建一个 `.clang` 文件，可以将编译参数逐行写入。也可以使用一 List 值来初始化该选项。 -例如： `clang_flag = ["-Iwhatever"]` +例如：`clang_flag = ["-Iwhatever"]` 以下为一个完整的 `lang#c` 模块载入示例： diff --git a/docs/cn/layers/lang/clojure.md b/docs/cn/layers/lang/clojure.md index c6c6cf4c2..c342ec19a 100644 --- a/docs/cn/layers/lang/clojure.md +++ b/docs/cn/layers/lang/clojure.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#clojure 模块" -description: "这一模块为 clojure 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Clojure 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -16,11 +16,10 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 clojure 开发支持，主要包括插件vim-clojure-static 和 vim-fireplace。 +这一模块为 SpaceVim 提供了 Clojure 开发支持，主要包括插件 vim-clojure-static 和 vim-fireplace。 ## 功能特性 - - 代码补全 - 文档查询 - 跳转定义处 diff --git a/docs/cn/layers/lang/csharp.md b/docs/cn/layers/lang/csharp.md index 9b7ffdc87..29fa78589 100644 --- a/docs/cn/layers/lang/csharp.md +++ b/docs/cn/layers/lang/csharp.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#csharp 模块" -description: "该模块为 SpaceVim 提供 csharp 开发支持，包括代码高亮、对齐、补全等特性。" +description: "这一模块为 SpaceVim 提供了 CSharp 的开发支持，包括代码高亮、对齐、补全等特性。" lang: cn --- @@ -18,7 +18,7 @@ lang: cn ## 模块简介 -该模块为 SpaceVim 提供 csharp 开发支持，包括代码高亮、对齐、补全等特性。 +这一模块为 SpaceVim 提供了 CSharp 的开发支持，包括代码高亮、对齐、补全等特性。 ## 依赖安装及模块启用 diff --git a/docs/cn/layers/lang/dart.md b/docs/cn/layers/lang/dart.md index cf7e0855c..cb2fc739b 100644 --- a/docs/cn/layers/lang/dart.md +++ b/docs/cn/layers/lang/dart.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#dart 模块" -description: "这一模块为 dart 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Dart 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -24,7 +24,7 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 dart 开发支持，包括代码补全、语法检查、以及代码格式化等特性。 +这一模块为 SpaceVim 提供了 Dart 的开发支持，包括代码补全、语法检查、代码格式化等特性。 ## 功能特性 @@ -47,11 +47,11 @@ lang: cn ### 语法检查及代码格式化 -为了在 SpaceVim 中启用 dart 语法检查以及代码格式化，需要安装 [dart sdk](https://github.com/dart-lang/sdk)。 +为了在 SpaceVim 中启用 Dart 语法检查以及代码格式化，需要安装 [dart sdk](https://github.com/dart-lang/sdk)。 ### 安装 dart-repl -需要通过 pub 来安装 `dart_repl` ，pub 是 dart sdk 内置的包管理器： +需要通过 pub 来安装 `dart_repl`，pub 是 Dart sdk 内置的包管理器： ```sh pub global activate dart_repl @@ -61,36 +61,36 @@ pub global activate dart_repl ### 交互式编程 -启动 `dart.repl` 交互进程，快捷键为： `SPC l s i`。 +启动 `dart.repl` 交互进程，快捷键为：`SPC l s i`。 将代码传输给 REPL 进程执行： -| 快捷键 | 描述 | -| ----------- | --------------------------- | +| 快捷键 | 描述 | +| ----------- | ----------------------- | | `SPC l s b` | 发送整个文件内容至 REPL | -| `SPC l s l` | 发送当前行内容至 REPL | -| `SPC l s s` | 发送已选中的内容至 REPL | +| `SPC l s l` | 发送当前行内容至 REPL | +| `SPC l s s` | 发送已选中的内容至 REPL | ### 运行当前脚本 -在编辑 dart 文件是，可通过快捷键 `SPC l r` 快速异步运行当前文件，运行结果会展示在一个独立的执行窗口内。 +在编辑 Dart 文件时，可通过快捷键 `SPC l r` 快速异步运行当前文件，运行结果会展示在一个独立的执行窗口内。 ### 代码格式化 -| 快捷键 | 描述 | -| ----------- | --------------------- | +| 快捷键 | 描述 | +| ----------- | -------------- | | `SPC b f` | 格式化当前文件 | ## 相关截图 -**代码格式化:** +**代码格式化：** ![format-dart-file-in-spacevim](https://user-images.githubusercontent.com/13142418/34455939-b094db54-ed4f-11e7-9df0-80cf5de1128d.gif) -**代码补全:** +**代码补全：** ![complete-dart-in-spacevim](https://user-images.githubusercontent.com/13142418/34455816-ee77182c-ed4c-11e7-8f63-402849f60405.png) -**异步执行:** +**异步执行：** ![dart-runner-in-spacevim](https://user-images.githubusercontent.com/13142418/34455403-1f6d4c3e-ed44-11e7-893f-09a6e64e27ed.png) diff --git a/docs/cn/layers/lang/dockerfile.md b/docs/cn/layers/lang/dockerfile.md index b9c607eba..8c3448ad9 100644 --- a/docs/cn/layers/lang/dockerfile.md +++ b/docs/cn/layers/lang/dockerfile.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#dockerfile 模块" -description: "这一模块为 dockerfile 的编辑提供了部分功能支持，包括语法高亮和自动补全。" +description: "这一模块为 SpaceVim 提供了 Dockerfile 编辑的部分功能支持，包括语法高亮和自动补全。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块简介 -这一模块为 dockerfile 的编辑提供了部分功能支持，包括语法高亮和自动补全。 +这一模块为 SpaceVim 提供了 Dockerfile 编辑的部分功能支持，包括语法高亮和自动补全。 ## 功能特性 @@ -32,7 +32,7 @@ lang: cn name = "lang#dockerfile" ``` -若需要启用语言服务器支持，需要额外安装 dockerfile 的语言服务器 [dockerfile-language-server-nodejs](https://github.com/rcjsuen/dockerfile-language-server-nodejs)。 +若需要启用语言服务器支持，需要额外安装 Dockerfile 的语言服务器 [dockerfile-language-server-nodejs](https://github.com/rcjsuen/dockerfile-language-server-nodejs)。 ```sh npm install -g dockerfile-language-server-nodejs diff --git a/docs/cn/layers/lang/elixir.md b/docs/cn/layers/lang/elixir.md index 19126eea8..b9e05ca34 100644 --- a/docs/cn/layers/lang/elixir.md +++ b/docs/cn/layers/lang/elixir.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#elixir 模块" -description: "这一模块为 elixir 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Elixir 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- diff --git a/docs/cn/layers/lang/elm.md b/docs/cn/layers/lang/elm.md index 63d020798..588c1c822 100644 --- a/docs/cn/layers/lang/elm.md +++ b/docs/cn/layers/lang/elm.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#elm 模块" -description: "这一模块为 elm 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Elm 的开发支持，包括代码补全、语法检查、代码格式化等特性。" image: https://user-images.githubusercontent.com/13142418/44625046-7b2f7700-a931-11e8-807e-dba3f73c9e90.png lang: cn --- @@ -22,7 +22,7 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 elm 开发支持，包括代码补全、语法检查、以及代码格式化等特性。 +这一模块为 SpaceVim 提供了 Elm 开发支持，包括代码补全、语法检查、以及代码格式化等特性。 ## 功能特性 @@ -32,7 +32,7 @@ lang: cn - 语法检查 - 文档查询 -同时，SpaceVim 还为 elm 开发提供了交互式编程。 +同时，SpaceVim 还为 Elm 开发提供了交互式编程。 ## 依赖安装及启用模块 diff --git a/docs/cn/layers/lang/extra.md b/docs/cn/layers/lang/extra.md index 710a4b11d..e4b4d3823 100644 --- a/docs/cn/layers/lang/extra.md +++ b/docs/cn/layers/lang/extra.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#extra 模块" -description: "该模块主要为一些不常见的语言添加语法支持，主要包括语法高亮、对齐等特性" +description: "这一模块为 SpaceVim 提供了一些不常见的语言添加语法支持，主要包括语法高亮、对齐等特性。" lang: cn --- @@ -28,8 +28,8 @@ lang: cn | coffee script | 语法高亮 | | irssi config | 语法高亮 | | vimperator config | 语法高亮 | -| Pug (formerly Jade) | 语法高亮, 代码对齐 | -| mustache | 语法高亮, 括号跳转, 文本对象 | +| Pug (formerly Jade) | 语法高亮，代码对齐 | +| mustache | 语法高亮，括号跳转，文本对象 | ## 启用模块 diff --git a/docs/cn/layers/lang/fsharp.md b/docs/cn/layers/lang/fsharp.md index 9b691dc9c..ea3f65307 100644 --- a/docs/cn/layers/lang/fsharp.md +++ b/docs/cn/layers/lang/fsharp.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#fsharp 模块" -description: "这一模块为 fsharp 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 FSharp 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块简介 -这一模块为在 SpaceVim 中进行 fsharp 开发提供了支持. +这一模块为在 SpaceVim 中进行 FSharp 开发提供了支持. ## 功能特性 diff --git a/docs/cn/layers/lang/go.md b/docs/cn/layers/lang/go.md index 53c7c068e..ff8867bb0 100644 --- a/docs/cn/layers/lang/go.md +++ b/docs/cn/layers/lang/go.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#go 模块" -description: "这一模块为 go 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Go 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -17,7 +17,7 @@ lang: cn ## 模块简介 -该模块为 SpaceVim 提供了 golang 开发支持，包括代码补全，格式化，语法检查等特性。同时提供诸多语言专属快捷键。 +该模块为 SpaceVim 提供了 Golang 开发支持，包括代码补全，格式化，语法检查等特性。同时提供诸多语言专属快捷键。 ## 启用模块 @@ -37,7 +37,7 @@ lang: cn ## 快捷键 -**语言专属快捷键:** +**语言专属快捷键：** | 快捷键 | 描述 | | --------- | ------------------------- | @@ -63,9 +63,9 @@ lang: cn | `SPC l v` | freevars | | `SPC l x` | go run | -**代码格式化:** +**代码格式化：** -默认的代码格式化快捷键是 `SPC b f`，该快捷键又 `format` 模块定义，同时也可以通过 `g =` 来对其整个文档。 +默认的代码格式化快捷键是 `SPC b f`，该快捷键由 `format` 模块定义，同时也可以通过 `g =` 来对其整个文档。 -为了使得 `format` 模块支持 go 文件，需要确认有可执行命令 [go-fmt](http://golang.org/cmd/gofmt/) 或者 [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports)， +为了使得 `format` 模块支持 Go 文件，需要确认有可执行命令 [go-fmt](http://golang.org/cmd/gofmt/) 或者 [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports)， 通常 `go-fmt` 命令为 go 自带的程序，请确认 go 开发环境是否配置正确。 diff --git a/docs/cn/layers/lang/haskell.md b/docs/cn/layers/lang/haskell.md index 3250a2c8c..58b121d0b 100644 --- a/docs/cn/layers/lang/haskell.md +++ b/docs/cn/layers/lang/haskell.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#haskell 模块" -description: "这一模块为 haskell 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Haskell 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块简介 -这一模块为 haskell 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 +这一模块为 Haskell 开发提供支持，包括代码补全、语法检查、代码格式化等特性。 ## 启用模块 @@ -34,4 +34,3 @@ lang: cn - 跳转定义处 - 查询函数引用 - lsp 支持 - diff --git a/docs/cn/layers/lang/html.md b/docs/cn/layers/lang/html.md index 698580016..645002436 100644 --- a/docs/cn/layers/lang/html.md +++ b/docs/cn/layers/lang/html.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#html 模块" -description: "这一模块为 html 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 HTML 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- diff --git a/docs/cn/layers/lang/php.md b/docs/cn/layers/lang/php.md index 678c9d561..41d353178 100644 --- a/docs/cn/layers/lang/php.md +++ b/docs/cn/layers/lang/php.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#php 模块" -description: "这一模块为 php 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 PHP 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -17,7 +17,7 @@ lang: cn ## 模块简介 -这一模块为在 SpaceVim 中进行 php 开发提供了支持，包括代码补全、语法检查、代码格式化、交互式编程以及调试等特性。 +这一模块为在 SpaceVim 中进行 PHP 开发提供了支持，包括代码补全、语法检查、代码格式化、交互式编程以及调试等特性。 ## 功能特性 diff --git a/docs/cn/layers/lang/plantuml.md b/docs/cn/layers/lang/plantuml.md index e274dcf08..798379c09 100644 --- a/docs/cn/layers/lang/plantuml.md +++ b/docs/cn/layers/lang/plantuml.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#plantuml 模块" -description: "这一模块为 plantuml 开发提供支持，包括语法高亮、实时预览等特性。" +description: "这一模块为 SpaceVim 提供了 PlantUML 的开发支持，包括语法高亮、实时预览等特性。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 plantuml 开发支持。 +这一模块为 SpaceVim 提供了 PlantUML 的开发支持，包括语法高亮、实时预览等特性。 ## 功能特性 diff --git a/docs/cn/layers/lang/puppet.md b/docs/cn/layers/lang/puppet.md index 8aedd7c4e..da45ad2d3 100644 --- a/docs/cn/layers/lang/puppet.md +++ b/docs/cn/layers/lang/puppet.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#puppet 模块" -description: "该模块为 SpaceVim 提供了 puppet 语言开发支持，包括语法高亮、语言服务器支持。" +description: "这一模块为 SpaceVim 提供了 Puppet 的开发支持，包括语法高亮、语言服务器支持。" image: https://user-images.githubusercontent.com/13142418/46022200-bb426f00-c114-11e8-84bc-d52dc83806c6.png lang: cn --- @@ -17,7 +17,7 @@ lang: cn ## 模块简介 -该模块为 SpaceVim 提供了 puppet 语言开发支持。 +该模块为 SpaceVim 提供了 Puppet 语言开发支持。 ![puppet ide](https://user-images.githubusercontent.com/13142418/46022200-bb426f00-c114-11e8-84bc-d52dc83806c6.png) diff --git a/docs/cn/layers/lang/purescript.md b/docs/cn/layers/lang/purescript.md index 9579ee8c0..499e0bb0e 100644 --- a/docs/cn/layers/lang/purescript.md +++ b/docs/cn/layers/lang/purescript.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#purescript 模块" -description: "这一模块为 purescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 PureScript 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -19,7 +19,7 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 purescript 开发支持，包括代码补全、语法检查、以及代码格式化等特性。 +这一模块为 SpaceVim 提供了 PureScript 开发支持，包括代码补全、语法检查、以及代码格式化等特性。 ## 功能特性 @@ -27,7 +27,7 @@ lang: cn - 文档查询 - 跳转定义处 -同时，SpaceVim 还为 purescript 开发提供了交互式编程、一键运行和语言服务器等功能。若要启用语言服务器，需要载入 `lsp` 模块。 +同时，SpaceVim 还为 PureScript 开发提供了交互式编程、一键运行和语言服务器等功能。若要启用语言服务器，需要载入 `lsp` 模块。 ## 启用模块 @@ -60,7 +60,7 @@ lang: cn ### 交互式编程 -启动 `pulp repl` 交互进程，快捷键为： `SPC l s i`。 +启动 `pulp repl` 交互进程，快捷键为：`SPC l s i`。 将代码传输给 REPL 进程执行： diff --git a/docs/cn/layers/lang/scheme.md b/docs/cn/layers/lang/scheme.md index f92036a4a..e825ef151 100644 --- a/docs/cn/layers/lang/scheme.md +++ b/docs/cn/layers/lang/scheme.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#scheme 模块" -description: "该模块为 SpaceVim 提供了 scheme 语言开发支持，包括语法高亮、语言服务器支持。" +description: "这一模块为 SpaceVim 提供了 Scheme 语言开发支持，包括语法高亮、语言服务器支持。" lang: cn image: https://user-images.githubusercontent.com/13142418/46590501-4e50b100-cae6-11e8-9366-6772d129a13b.png --- @@ -17,7 +17,7 @@ image: https://user-images.githubusercontent.com/13142418/46590501-4e50b100-cae6 ## 模块简介 -该模块为 SpaceVim 提供了 scheme 语言开发支持。 +这一模块为 SpaceVim 提供了 Scheme 语言开发支持，包括语法高亮、语言服务器支持。 ## 功能特性 diff --git a/docs/cn/layers/lang/sh.md b/docs/cn/layers/lang/sh.md index fa8381a1d..273d78d5b 100644 --- a/docs/cn/layers/lang/sh.md +++ b/docs/cn/layers/lang/sh.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#sh 模块" -description: "这一模块为 shell script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Shell Script 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -18,7 +18,7 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 shell script 开发支持。Shell script 是指 bash script 和 zsh script。 +这一模块为 SpaceVim 提供了 Shell Script 开发支持。Shell Script 是指 Bash script 和 Zsh script。 ## 功能特性 @@ -28,7 +28,7 @@ lang: cn - 代码格式化 - 跳转定义处 -同时，SpaceVim 还为 shell script 开发提供了语言服务器等功能。若要启用语言服务器，需要载入 `lsp` 模块。 +同时，SpaceVim 还为 Shell Script 开发提供了语言服务器等功能。若要启用语言服务器，需要载入 `lsp` 模块。 ## 启用模块 @@ -43,8 +43,8 @@ lang: cn ### 语言专属快捷键 -| 按键 | 功能描述 | -| --------------- | --------------------------------------- | -| `SPC l d` / `K` | 展示光标函数或变量相关文档 | -| `g d` | 跳至函数或变量定义处 | +| 按键 | 功能描述 | +| --------------- | -------------------------- | +| `SPC l d` / `K` | 展示光标函数或变量相关文档 | +| `g d` | 跳至函数或变量定义处 | diff --git a/docs/cn/layers/lang/swift.md b/docs/cn/layers/lang/swift.md index 15b3f107f..1c29e3de0 100644 --- a/docs/cn/layers/lang/swift.md +++ b/docs/cn/layers/lang/swift.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#swift 模块" -description: "该模块主要为 SpaceVim 提供了 swift 开发支持，包括语法高亮、语法检查等特性。" +description: "这一模块为 SpaceVim 提供了 Swift 的开发支持，包括语法高亮、语法检查等特性。" lang: cn --- @@ -17,7 +17,7 @@ lang: cn ## 模块简介 -该模块主要为 SpaceVim 提供了 swift 开发支持。 +这一模块为 SpaceVim 提供了 Swift 的开发支持，包括语法高亮、语法检查等特性。 ## 功能特性 @@ -35,6 +35,6 @@ lang: cn ## 快捷键 -| 按键 | 功能描述 | +| 按键 | 功能描述 | | ----------- | ----------------------- | | `SPC l k` | jumping to placeholders | diff --git a/docs/cn/layers/lang/typescript.md b/docs/cn/layers/lang/typescript.md index 5a11180fa..2df9ae13c 100644 --- a/docs/cn/layers/lang/typescript.md +++ b/docs/cn/layers/lang/typescript.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#typescript 模块" -description: "这一模块为 typescript 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Typescript 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -18,7 +18,7 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 typescript 开发支持，包括代码补全、语法检查、以及代码格式化等特性。 +这一模块为 SpaceVim 提供了 Typescript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 ## 启用模块 @@ -51,7 +51,7 @@ npm install -g typescript ## 快捷键 -| 快捷键 | 功能描述 | +| 快捷键 | 功能描述 | | ----------- | ------------------ | | `SPC l c` | type definition | | `SPC l d` | show documentation | @@ -62,4 +62,4 @@ npm install -g typescript | `SPC l r` | references | | `SPC l s` | search | | `SPC l t` | type | -| `g d` | defintion preview | +| `g d` | defintion preview | diff --git a/docs/cn/layers/lang/vim.md b/docs/cn/layers/lang/vim.md index d97a60d37..1f91212dc 100644 --- a/docs/cn/layers/lang/vim.md +++ b/docs/cn/layers/lang/vim.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#vim 模块" -description: "这一模块为 vim script 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Vimscript 的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块简介 -该模块主要为 Vim 脚本编辑提供支持，包括代码补全，语法检查等特性。 +这一模块为 SpaceVim 提供了 Vimscript 的开发支持，包括代码补全、语法检查、代码格式化等特性。 ## 启用模块 diff --git a/docs/cn/layers/lang/vue.md b/docs/cn/layers/lang/vue.md index b00cb4e63..2806757df 100644 --- a/docs/cn/layers/lang/vue.md +++ b/docs/cn/layers/lang/vue.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lang#vue 模块" -description: "这一模块为 vue 开发提供支持，包括代码补全、语法检查、代码格式化等特性。" +description: "这一模块为 SpaceVim 提供了 Vue 的的开发支持，包括代码补全、语法检查、代码格式化等特性。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块简介 -这一模块为 SpaceVim 提供了 vue 开发支持。该模块包含了插件 [vim-vue](https://github.com/posva/vim-vue)。 +这一模块为 SpaceVim 提供了 Vue 的的开发支持，包括代码补全、语法检查、代码格式化等特性。该模块包含了插件 [vim-vue](https://github.com/posva/vim-vue)。 ## 功能特性 diff --git a/docs/cn/layers/language-server-protocol.md b/docs/cn/layers/language-server-protocol.md index b3bc6c7ff..e310bceaf 100644 --- a/docs/cn/layers/language-server-protocol.md +++ b/docs/cn/layers/language-server-protocol.md @@ -1,6 +1,6 @@ --- title: "SpaceVim lsp 模块" -description: "lsp 模块为 SpaceVim 提供 language server protocol 的支持，提供更多语言相关服务" +description: "这一模块为 SpaceVim 提供了 language server protocol 的支持，提供更多语言相关服务。" lang: cn --- @@ -23,9 +23,9 @@ lsp 模块提供了 [language-server-protocol](https://microsoft.github.io/langu 这以模块在 [LanguageClient-neovim](https://github.com/SpaceVim/LanguageClient-neovim) 基础上做了许多定制， 这一链接为一克隆的版本，需要 `+python` 支持。 -同时，当你的 Vim 不支持 `+python3` 时，我们采用 [vim-lsp](https://github.com/prabirshrestha/vim-lsp) 这一使用纯 vim 脚本书写的插件。 +同时，当你的 Vim 不支持 `+python3` 时，我们采用 [vim-lsp](https://github.com/prabirshrestha/vim-lsp) 这一使用纯 Vim 脚本书写的插件。 -neovim 团队也在尝试实现一个内置的 [lsp 框架](https://github.com/neovim/neovim/pull/6856)，后续该框架完成后，在 neovim 内将默认使用该框架。 +Neovim 团队也在尝试实现一个内置的 [lsp 框架](https://github.com/neovim/neovim/pull/6856)，后续该框架完成后，在 Neovim 内将默认使用该框架。 在 SpaceVim 内部，lsp 的框架选择逻辑大致时这样的： @@ -52,11 +52,11 @@ endif - 代码格式化 - 代码自动修复 -**注:** 以上所有信息依赖于语言服务器所实现的功能，请查阅 [Language Servers](https://microsoft.github.io/language-server-protocol/implementors/servers/) 列表。 +**注：** 以上所有信息依赖于语言服务器所实现的功能，请查阅 [Language Servers](https://microsoft.github.io/language-server-protocol/implementors/servers/) 列表。 ## 模块安装 -默认未载入，如需载入该模块，可在配置文件加入: +默认未载入，如需载入该模块，可在配置文件加入： ```toml [[layers]] @@ -118,7 +118,7 @@ npm install vue-language-server -g | 语言 | 命令 | | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `javascript` | `['javascript-typescript-stdio']` | -| `sh` | `['bash-language-server', 'start']` | +| `sh` | `['bash-language-server', 'start']` | | `typescript` | `['typescript-language-server', '--stdio']` | | `haskell` | `['hie', '--lsp']` | | `c` | `['clangd']` | diff --git a/docs/cn/layers/leaderf.md b/docs/cn/layers/leaderf.md index be9ff87e0..559fde39c 100644 --- a/docs/cn/layers/leaderf.md +++ b/docs/cn/layers/leaderf.md @@ -1,6 +1,6 @@ --- -title: "SpaceVim leaderf模块" -description: "提供以 leaderf 为核心的异步模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。" +title: "SpaceVim leaderf 模块" +description: "这一模块为 SpaceVim 提供了以 leaderf 为核心的异步模糊查找机制，支持模糊搜索文件、历史记录、函数列表等。" lang: cn --- @@ -16,7 +16,7 @@ lang: cn ## 模块介绍 -这一模块在 leaderf 的基础上做了时当的包装和定制，提供了搜索文件、函数列表、 +这一模块在 leaderf 的基础上做了适当的包装和定制，提供了搜索文件、函数列表、 命令历史等等特性。 ## 启用模块 diff --git a/docs/cn/layers/shell.md b/docs/cn/layers/shell.md index 813b9ed18..36322b2c3 100644 --- a/docs/cn/layers/shell.md +++ b/docs/cn/layers/shell.md @@ -1,6 +1,6 @@ --- title: "SpaceVim shell 模块" -description: "这一模块为 SpaceVim 提供了终端集成特性，优化内置终端的使用体验" +description: "这一模块为 SpaceVim 提供了终端集成特性，优化内置终端的使用体验。" lang: cn --- @@ -19,11 +19,11 @@ lang: cn ## 模块描述 -这一模块为 SpaceVim 提供了 shell 集成，根据当前 vim/neovim 的版本，优化自带的内置终端。 +这一模块为 SpaceVim 提供了 shell 集成，根据当前 Vim/Neovim 的版本，优化自带的内置终端。 ## 启用模块 -如果需要启用该模块，需要在 SpaceVim 的配置文件内添加如下代码： +如果需要启用该模块，需要在 SpaceVim 的配置文件内添加如下配置： ```toml [[layers]] @@ -36,7 +36,7 @@ lang: cn SpaceVim 支持两种 shell，用户在启用该模块时，可以通过 `default_shell` 这一模块选项来指定默认的 shell 工具。 -- terminal：使用 vim/neovim 内置终端 +- terminal：使用 Vim/Neovim 内置终端 - VimShell：使用 VimShell 这一插件 The default shell is quickly accessible via a the default shortcut key `SPC '`. diff --git a/docs/cn/layers/sudo.md b/docs/cn/layers/sudo.md index b23e25e08..b3f7ce902 100644 --- a/docs/cn/layers/sudo.md +++ b/docs/cn/layers/sudo.md @@ -1,6 +1,6 @@ --- title: "SpaceVim sudo 模块" -description: "sudo 提供了在 SpaceVim 中以管理员身份读写文件的功能。" +description: "这一模块为 SpaceVim 提供了以管理员身份读写文件的功能。" lang: cn --- diff --git a/docs/cn/layers/tags.md b/docs/cn/layers/tags.md index 614986a92..153caa144 100644 --- a/docs/cn/layers/tags.md +++ b/docs/cn/layers/tags.md @@ -1,6 +1,7 @@ --- title: "SpaceVim tags 模块" -description: "tags 模块提供全局的 tags 索引管理，提供快速检索定义和引用的功能。" +description: "这一模块为 SpaceVim 提供了全局的 tags 索引管理，提供快速检索定义和引用的功能。" +lang: cn --- # [可用模块](../) >> tags @@ -90,7 +91,7 @@ sudo make install ##### 配置 pygments 和 ctags 环境 -To be able to use pygments and ctags, you need to copy the sample gtags.conf either to /etc/gtags.conf or +To be able to use pygments and ctags, you need to copy the sample gtags.conf either to /etc/gtags.conf or 如果需要启用 pygments 和 ctags，需要复制示例 gtags.conf 至 `/etc/gtags.conf` 或者 `$HOME/.globalrc`。例如： ```sh @@ -145,20 +146,20 @@ gtags --gtagslabel=pygments #### 通过 exuberant ctags 支持的语言 -如果你启用了 `exuberant ctags`，并且使用其作为后台(i.e., GTAGSLABEL=ctags or –gtagslabel=ctags)，那么如下的语言将也得到支持： +如果你启用了 `exuberant ctags`，并且使用其作为后台(i.e., GTAGSLABEL=ctags or–gtagslabel=ctags)，那么如下的语言将也得到支持： -- c# -- erlang -- javascript +- C# +- Erlang +- JavaScript - common-lisp -- emacs-lisp -- lua -- ocaml -- python -- ruby -- scheme -- vimscript -- windows-scripts (.bat .cmd files) +- Emacs-lisp +- Lua +- Ocaml +- Python +- Ruby +- Scheme +- Vimscript +- Windows-scripts (.bat .cmd files) #### 通过 Universal ctags 支持的语言 @@ -177,13 +178,13 @@ pygments 后，可以通过 gtags 查询函数和变量的定义以及引用处 当 pygments 启用后，如下语言将得以支持： - elixir -- fsharp -- haskell -- octave +- FSharp +- Haskell +- Octave - racket -- scala +- Scala - shell-scripts -- tex +- TeX ## 快捷键 diff --git a/docs/cn/layers/tmux.md b/docs/cn/layers/tmux.md index 7d8356177..61c8b95d5 100644 --- a/docs/cn/layers/tmux.md +++ b/docs/cn/layers/tmux.md @@ -1,6 +1,6 @@ --- title: "SpaceVim tmux 模块" -description: "该模块主要提供了一些在 Vim 内操作 tmux 的功能，使得在 tmux 窗口之间跳转更加便捷。" +description: "这一模块为 SpaceVim 提供了一些在 Vim 内操作 tmux 的功能，使得在 tmux 窗口之间跳转更加便捷。" lang: cn --- @@ -37,8 +37,8 @@ lang: cn ## 模块选项 -- `tmuxline_separators`: 设置tmux的主要分隔符，默认等同于SpaceVim的 `statusline_separator`, 可选值包括: `arrow`, `curve`, `slant`, `barce`, `fire`, `nil` -- `tmuxline_separators_alt`: 设置tmux的分隔符，默认等同于SpaceVim的 `statusline_inactive_separator`，可选值包括: `arrow`, `bar`, `nil` +- `tmuxline_separators`: 设置 tmux 的主要分隔符，默认等同于 SpaceVim 的 `statusline_separator`, 可选值包括：`arrow`, `curve`, `slant`, `barce`, `fire`, `nil` +- `tmuxline_separators_alt`: 设置 tmux 的分隔符，默认等同于 SpaceVim 的 `statusline_inactive_separator`，可选值包括：`arrow`, `bar`, `nil` - `tmux_navigator_modifier`: 设置 tmux 的移动快捷键，默认是 `ctrl`，可选值包括：`alt`, `ctrl` ## 快捷键 diff --git a/docs/cn/layers/tools.md b/docs/cn/layers/tools.md index 99eb00729..376d3d037 100644 --- a/docs/cn/layers/tools.md +++ b/docs/cn/layers/tools.md @@ -1,6 +1,6 @@ --- title: "SpaceVim tools 模块" -description: "集成多种常用工具，包括日历、计算器、等等多种工具类插件，该模块针对 vim8 以及 neovim 提供了更好的插件选择。" +description: "这一模块为 SpaceVim 提供了多种常用工具，包括日历、计算器等多种工具类插件，并针对 Vim8 以及 Neovim 提供了更好的插件选择。" lang: cn --- diff --git a/docs/cn/layers/tools/dash.md b/docs/cn/layers/tools/dash.md index 8923ce32a..baa89f162 100644 --- a/docs/cn/layers/tools/dash.md +++ b/docs/cn/layers/tools/dash.md @@ -1,6 +1,6 @@ --- title: "SpaceVim tools#dash 模块" -description: "该模块提供对 Dash 支持，可快速查找光标位置的单词" +description: "这一模块为 SpaceVim 提供了 Dash 支持，可快速查找光标位置的单词。" lang: cn --- @@ -16,11 +16,11 @@ lang: cn ## 模块描述 -该模块为 SpaceVim 提供了 Dash 集成 +该模块为 SpaceVim 提供了 Dash 集成。 ## 启用模块 -tools#dash 模块默认并为启用，如果需要启用该模块，需要在配置文件里面加入： +tools#dash 模块默认并未启用，如果需要启用该模块，需要在配置文件里面加入： ```toml [[layers]] diff --git a/docs/cn/layers/ui.md b/docs/cn/layers/ui.md index dbdfcb603..3a79410f1 100644 --- a/docs/cn/layers/ui.md +++ b/docs/cn/layers/ui.md @@ -1,6 +1,6 @@ --- title: "SpaceVim ui 模块" -description: "SpaceVim ui 模块提供了一个 IDE-like 的界面，包括状态栏、文件树、语法数等等特性。" +description: "这一模块为 SpaceVim 提供了 IDE-like 的界面，包括状态栏、文件树、语法树等等特性。" lang: cn --- diff --git a/docs/cn/layers/unite.md b/docs/cn/layers/unite.md index ba65454a4..301636d10 100644 --- a/docs/cn/layers/unite.md +++ b/docs/cn/layers/unite.md @@ -1,6 +1,6 @@ --- title: "SpaceVim unite 模块" -description: "提供以 unite 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。" +description: "这一模块为 SpaceVim 提供以 unite 为核心的模糊查找机制，支持模糊搜索文件、历史纪录、函数列表等。" lang: cn --- diff --git a/docs/cn/quick-start-guide.md b/docs/cn/quick-start-guide.md index a3f07d1f4..09e207cda 100644 --- a/docs/cn/quick-start-guide.md +++ b/docs/cn/quick-start-guide.md @@ -1,5 +1,5 @@ --- -title: "入门指南" +title: "入门指南" description: "SpaceVim 入门教程，包括安装初始化配置等内容" lang: cn --- @@ -17,25 +17,25 @@ lang: cn - [Windows](#windows) - [在 Docker 中运行](#在-docker-中运行) - [配置](#配置) -- [学习SpaceVim](#学习spacevim) +- [学习 SpaceVim](#学习-spacevim) - [在线指南](#在线指南) ### 安装 -在安装 SpaceVim 之前，你需要确保电脑上已经安装了 `git` 和 `curl`。这两个工具用来 +在安装 SpaceVim 之前，你需要确保电脑上已经安装了 `Git` 和 `cURL`。这两个工具用来 下载插件以及字体。 -如果在终端中使用 vim 或者 neovim，还需要设置终端的字体。 +如果在终端中使用 Vim 或 Neovim，还需要设置终端的字体。 #### Linux 或 macOS -```bash +```sh curl -sLf https://spacevim.org/cn/install.sh | bash ``` -安装结束后，初次打开 `vim` 或者 `gvim` 时， SpaceVim 会**自动**下载并安装插件。 +安装结束后，初次打开 `Vim` 或者 `gVim` 时，SpaceVim 会**自动**下载并安装插件。 如果需要获取安装脚本的帮助信息，可以执行如下命令，包括定制安装、更新和卸载等。 @@ -45,7 +45,7 @@ curl -sLf https://spacevim.org/cn/install.sh | bash -s -- -h #### Windows -windows 下最快捷的安装方法是下载安装脚本 [install.cmd](https://spacevim.org/cn/install.cmd) 并运行。 +Windows 下最快捷的安装方法是下载安装脚本 [install.cmd](https://spacevim.org/cn/install.cmd) 并运行。 ### 在 Docker 中运行 @@ -55,7 +55,7 @@ docker pull spacevim/spacevim docker run -it --rm spacevim/spacevim nvim ``` -也可以通过挂载的方式，载入本地配置： +也可以通过挂载的方式载入本地配置： ```sh docker run -it -v ~/.SpaceVim.d:/home/spacevim/.SpaceVim.d --rm spacevim/spacevim nvim @@ -71,12 +71,12 @@ SpaceVim 的默认配置文件为 `~/.SpaceVim.d/init.toml`。下面为一简单 ```toml # 这是一个基础的 SpaceVim 配置示例 -# 所有的 SpaceVim 选项都列在 [option] 之下 +# 所有的 SpaceVim 选项都列在 [options] 之下 [options] # 设置 SpaceVim 主题及背景，默认的主题是 gruvbox，如果你需要使用更 # 多的主题，你可以载入 colorscheme 模块 colorscheme = "gruvbox" - # 背景可以取值 "dark" 和 "light" + # 背景可以取值 "dark" 或 "light" colorscheme_bg = "dark" # 启用/禁用终端真色，在目前大多数终端下都是支持真色的，当然也有 # 一小部分终端不支持真色，如果你的 SpaceVim 颜色看上去比较怪异 @@ -87,13 +87,13 @@ SpaceVim 的默认配置文件为 `~/.SpaceVim.d/init.toml`。下面为一简单 statusline_separator = "nil" statusline_separator = "bar" # 设置顶部标签列表序号类型，有以下五种类型，分别是 0 - 4 - # 0: 1 ➛ ➊ + # 0: 1 ➛ ➊ # 1: 1 ➛ ➀ # 2: 1 ➛ ⓵ # 3: 1 ➛ ¹ # 4: 1 ➛ 1 buffer_index_type = 4 - # 显示/隐藏顶部标签栏上文件类型图标，这一图标需要安装 nerd fonts， + # 显示/隐藏顶部标签栏上的文件类型图标，这一图标需要安装 nerd fonts， # 如果未能成功安装这一字体，可以隐藏图标 enable_tabline_filetype_icon = true # 是否在状态栏上显示当前模式，默认情况下，不显示 Normal/Insert 等 @@ -102,41 +102,39 @@ SpaceVim 的默认配置文件为 `~/.SpaceVim.d/init.toml`。下面为一简单 # SpaceVim 模块设置，主要包括启用/禁用模块 -# 启用 autocomplete 模块, 启用模块时，可以列出一些模块选项，并赋值， +# 启用 autocomplete 模块，启用模块时，可以列出一些模块选项，并赋值， # 关于模块的选项，请阅读各个模块的文档 [[layers]] name = "autocomplete" auto-completion-return-key-behavior = "complete" auto-completion-tab-key-behavior = "cycle" -# 禁用 shell 模块, 禁用模块时，需要加入 enable = false +# 禁用 shell 模块，禁用模块时，需要加入 enable = false [[layers]] name = "shell" enable = false # 添加自定义插件 - [[custom_plugins]] name = "lilydjwg/colorizer" merged = 0 ``` -### 学习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 入门教程 +- [SpaceVim 入门教程](https://everettjf.gitbooks.io/spacevimtutorial/content/)：everettjf 所著的 SpaceVim 入门教程。 ### 在线指南 以下主要为 SpaceVim 的基本使用教程，侧重于各种语言开发环境的搭建，可以理解为 SpaceVim 用户文档的精简版，主要包括以下内容： -- [使用 SpaceVim 搭建基本的开发环境](../use-vim-as-ide/)：涵盖一些窗口及文件的常规操作 +- [使用 SpaceVim 搭建基本的开发环境](../use-vim-as-ide/)：涵盖一些窗口及文件的常规操作。 针对不同语言，一些基础的配置及使用技巧： -
        {% for post in site.categories.tutorials_cn %}
      • diff --git a/docs/cn/roadmap.md b/docs/cn/roadmap.md index a84b31c18..e12fe751b 100644 --- a/docs/cn/roadmap.md +++ b/docs/cn/roadmap.md @@ -1,6 +1,6 @@ --- title: "设计蓝图" -description: "SpaceVim 设计蓝图和里程碑， 这决定了 SpaceVim 的开发方向和特性实现的优先顺序。" +description: "SpaceVim 设计蓝图和里程碑，这决定了 SpaceVim 的开发方向和特性实现的优先顺序。" lang: cn --- diff --git a/docs/cn/sponsors.md b/docs/cn/sponsors.md index ccdd356ad..598664949 100644 --- a/docs/cn/sponsors.md +++ b/docs/cn/sponsors.md @@ -1,12 +1,12 @@ --- title: "赞助" -description: "SpaceVim 赞助方式，以及历史赞助，如果你想赞助 SpaceVim，或者希望 SpaceVim 开发的更快一点，可以选择以下某种方式进行赞助" +description: "SpaceVim 赞助方式，以及历史赞助，如果你想赞助 SpaceVim，或者希望 SpaceVim 开发的更快一点，可以选择以下某种方式进行赞助。" lang: cn --- # 赞助 -如果你想赞助 SpaceVim，或者希望 SpaceVim 开发的更快一点，可以选择以下某种方式进行赞助： +如果你想赞助 SpaceVim，或者希望 SpaceVim 开发得更快一点，可以选择以下某种方式进行赞助： - [通过 BountySource](https://www.bountysource.com/teams/spacevim) - [通过 Open Collective](https://opencollective.com/spacevim) @@ -19,85 +19,85 @@ lang: cn | ------------------------------------------------------------------------ | -------------------------------------------------------------------------- | | | | -比特币: 1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv +比特币：1DtuVeg81c2L9NEhDaVTAAbrCR3pN5xPFv ## 历史赞助 -以下是所有的历史赞助，记住那些曾经爱心赞助的人们，非常感谢，你们的鼓励就是我坚持的动力 (排名不分先后，如有遗漏疏忽，请务必告知) +以下是所有的历史赞助，记住那些曾经爱心赞助的人们，非常感谢，你们的鼓励就是我坚持的动力（排名不分先后，如有遗漏疏忽，请务必告知）。 -同时，你也可以查看 [Bountysource campaign](https://www.bountysource.com/teams/spacevim) 获取更多信息. +同时，你也可以查看 [Bountysource campaign](https://www.bountysource.com/teams/spacevim) 获取更多信息。 -| 日期     | 金额 | 描述                                   | -| ------------ | ------- | -------------------------------------- | -| 2016-09-26 | ¥ 100 | *好 | -| 2016-09-26 | ¥ 300 | *好 | -| 2016-11-22 | ¥ 20 | *续 | -| 2017-02-23 | ¥ 40 | *拔 | -| 2017-02-14 | ¥ 100 | *洁 | -| 2017-03-18 | ¥ 20 | z*t | -| 2017-03-30 | ¥ 20 | l*n | -| 2017-04-07 | ¥ 20 | *酱 | -| 2017-06-20 | $ 2.57 | Шепелев Григорий | -| 2017-06-24 | $ 14.04 | Vowell Jason | -| 2017-06-24 | $ 2.57 | Senaud Nicolas | -| 2017-09-16 | $ 2.57 | D'Avezac Mayeul | -| 2017-09-24 | ¥ 0.99 | 1*5 | -| 2017-11-02 | ¥ 10 | *下 | -| 2017-11-02 | ¥ 10 | *下 | -| 2017-11-20 | ¥ 1.6 | *瑞 | -| 2017-11-26 | $ 14.04 | Hermans Tim | -| 2017-12-13 | $ 5.44 | Ma Fei | -| 2017-12-27 | $ 8.30 | Módolo Marcelo | -| 2017-12-28 | ¥ 20 | s*n | -| 2017-12-28   | ¥ 10.24 | bts | -| 2017-12-29 | ¥ 10 | *哥 | -| 2018-01-22 | ¥ 10 | *强 | -| 2018-01-24 | ¥ 20 | unlockingc | -| 2018-02-05 | $ 2.57 | Samuel Mitchell | -| 2018-02-13 | $ 45 | talktopete | -| 2018-02-14 | ¥ 20 | *川 | -| 2018-02-14 | ¥ 188 | *黑8 | -| 2018-02-18 | ¥ 66.6 | *谨 | -| 2018-02-22 | $ 9 | sei40kr | -| 2018-02-24 | $ 6 | kapkabnh | -| 2018-03-14 | ¥ 1 | *目 | -| 2018-03-20 | $ 10 | kovaski | -| 2018-03-26 | ¥ 0.01 | *丰 | -| 2018-03-28 | $ 2.57 | 小林 | -| 2018-03-30 | ¥ 10 | 林* | -| 2018-03-31 | ¥ 18.88 | s*n | -| 2018-04-04 | ¥ 10 | 童* | -| 2018-04-06 | ¥ 9.99 | Galaxy | -| 2018-04-20 | ¥ 5 | 可*) | -| 2018-04-29 | ¥ 5 | *中 | -| 2018-05-07 | ¥ 6.6 | *浪 | -| 2018-05-09 | ¥ 10 | S*R | -| 2018-05-16 | $ 2.57 | Daniel Beste | -| 2018-06-18 | $ 11.17 | Charalambos | -| 2018-06-20 | $ 2.57 | Jingpeng Wu | -| 2018-06-24 | ¥ 50 | 青* | -| 2018-06-25 | $ 14.04 | Core Enable, LLC | -| 2018-07-16 | ¥ 5 | L_Collection | -| 2018-07-26 | $ 5.44 | John Femiani | -| 2018-07-31 | ¥ 10 | w*d | -| 2018-08-04 | ¥ 50 | *建 | -| 2018-08-12 | ¥ 20 | leo陶 | -| 2018-08-15 | ¥ 300 | 睿 | -| 2018-09-12 | ¥ 50 | 鉴*o | -| 2018-09-21 | $ 200 | chvanikoff | -| 2018-10-23 | $ 2.57 | Hongjun Fu | -| 2018-10-26 | $ 2.57 | Vladimir Kravtsov | -| 2018-10-23 | $ 2.57 | Hongjun Fu | -| 2018-11-13 | ¥ 8.8 | 开源 | -| 2018-11-14 | $ 14.04 | Mateusz | -| 2018-12-04 | ¥ 30 | 兵焦 | -| 2018-12-17 | ¥ 1 | *歌 | -| 2018-12-17 | ¥ 100 | 涛 | -| 2018-12-20 | ¥ 20.19 | *尘 | +| 日期     | 金额 | 描述               | +| ------------ | ------- | ----------------- | +| 2016-09-26 | ¥ 100 | *好 | +| 2016-09-26 | ¥ 300 | *好 | +| 2016-11-22 | ¥ 20 | *续 | +| 2017-02-23 | ¥ 40 | *拔 | +| 2017-02-14 | ¥ 100 | *洁 | +| 2017-03-18 | ¥ 20 | z*t | +| 2017-03-30 | ¥ 20 | l*n | +| 2017-04-07 | ¥ 20 | *酱 | +| 2017-06-20 | $ 2.57 | Шепелев Григорий | +| 2017-06-24 | $ 14.04 | Vowell Jason | +| 2017-06-24 | $ 2.57 | Senaud Nicolas | +| 2017-09-16 | $ 2.57 | D'Avezac Mayeul | +| 2017-09-24 | ¥ 0.99 | 1*5 | +| 2017-11-02 | ¥ 10 | *下 | +| 2017-11-02 | ¥ 10 | *下 | +| 2017-11-20 | ¥ 1.6 | *瑞 | +| 2017-11-26 | $ 14.04 | Hermans Tim | +| 2017-12-13 | $ 5.44 | Ma Fei | +| 2017-12-27 | $ 8.30 | Módolo Marcelo | +| 2017-12-28 | ¥ 20 | s*n | +| 2017-12-28   | ¥ 10.24 | bts | +| 2017-12-29 | ¥ 10 | *哥 | +| 2018-01-22 | ¥ 10 | *强 | +| 2018-01-24 | ¥ 20 | unlockingc | +| 2018-02-05 | $ 2.57 | Samuel Mitchell | +| 2018-02-13 | $ 45 | talktopete | +| 2018-02-14 | ¥ 20 | *川 | +| 2018-02-14 | ¥ 188 | *黑8 | +| 2018-02-18 | ¥ 66.6 | *谨 | +| 2018-02-22 | $ 9 | sei40kr | +| 2018-02-24 | $ 6 | kapkabnh | +| 2018-03-14 | ¥ 1 | *目 | +| 2018-03-20 | $ 10 | kovaski | +| 2018-03-26 | ¥ 0.01 | *丰 | +| 2018-03-28 | $ 2.57 | 小林 | +| 2018-03-30 | ¥ 10 | 林* | +| 2018-03-31 | ¥ 18.88 | s*n | +| 2018-04-04 | ¥ 10 | 童* | +| 2018-04-06 | ¥ 9.99 | Galaxy | +| 2018-04-20 | ¥ 5 | 可*) | +| 2018-04-29 | ¥ 5 | *中 | +| 2018-05-07 | ¥ 6.6 | *浪 | +| 2018-05-09 | ¥ 10 | S*R | +| 2018-05-16 | $ 2.57 | Daniel Beste | +| 2018-06-18 | $ 11.17 | Charalambos | +| 2018-06-20 | $ 2.57 | Jingpeng Wu | +| 2018-06-24 | ¥ 50 | 青* | +| 2018-06-25 | $ 14.04 | Core Enable, LLC | +| 2018-07-16 | ¥ 5 | L_Collection | +| 2018-07-26 | $ 5.44 | John Femiani | +| 2018-07-31 | ¥ 10 | w*d | +| 2018-08-04 | ¥ 50 | *建 | +| 2018-08-12 | ¥ 20 | leo陶 | +| 2018-08-15 | ¥ 300 | 睿 | +| 2018-09-12 | ¥ 50 | 鉴*o | +| 2018-09-21 | $ 200 | chvanikoff | +| 2018-10-23 | $ 2.57 | Hongjun Fu | +| 2018-10-26 | $ 2.57 | Vladimir Kravtsov | +| 2018-10-23 | $ 2.57 | Hongjun Fu | +| 2018-11-13 | ¥ 8.8 | 开源 | +| 2018-11-14 | $ 14.04 | Mateusz | +| 2018-12-04 | ¥ 30 | 兵焦 | +| 2018-12-17 | ¥ 1 | *歌 | +| 2018-12-17 | ¥ 100 | 涛 | +| 2018-12-20 | ¥ 20.19 | *尘 | ## 历史支出 -| 日期     | 金额 | 描述                                   | -| ---------- | ------- | -------------------------------------- | -| 2017-06-10 | - $ 5 | 主机 | -| 2017-01-03 | - ¥ 225 | 域名 | +| 日期     | 金额 | 描述 | +| ---------- | ------- | ----- | +| 2017-06-10 | - $ 5 | 主机 | +| 2017-01-03 | - ¥ 225 | 域名 | diff --git a/docs/quick-start-guide.md b/docs/quick-start-guide.md index 17206ead4..7c3a2e379 100644 --- a/docs/quick-start-guide.md +++ b/docs/quick-start-guide.md @@ -68,7 +68,7 @@ documentation. ```toml # This is basic configuration example for SpaceVim -# All SpaceVim option below [option] section +# All SpaceVim options are below [options] section [options] # set spacevim theme. by default colorscheme layer is not loaded, # if you want to use more colorscheme, please load the colorscheme