diff --git a/.projections.json b/.projections.json index 224407d73..74a4bafbc 100644 --- a/.projections.json +++ b/.projections.json @@ -102,5 +102,11 @@ }, "docs/_posts/2020-09-24-use-vim-as-a-kotlin-ide.md" : { "alternate": "docs/_posts/2020-09-25-use-vim-as-a-kotlin-ide.md" + }, + "README.md" : { + "alternate" : "README.cn.md" + }, + "README.cn.md" : { + "alternate" : "README.md" } } diff --git a/README.cn.md b/README.cn.md index 68bd2ad6f..1f32c279d 100644 --- a/README.cn.md +++ b/README.cn.md @@ -1,5 +1,13 @@ [![SpaceVim](docs/logo.png)](https://spacevim.org/cn/) +[Wiki](https://gitee.com/spacevim/SpaceVim/wikis) \| +[入门指南](https://spacevim.org/cn/quick-start-guide/) \| +[用户手册](https://spacevim.org/cn/documentation/) \| +[中文社区](https://spacevim.org/cn/community/) \| +[捐助](https://spacevim.org/cn/sponsors/) \| +[微博](https://weibo.com/SpaceVim) \| +[中文交流群](https://gitter.im/SpaceVim/SpaceVim) + [![Gitter](https://badges.gitter.im/SpaceVim/SpaceVim.svg)](https://gitter.im/SpaceVim/cn) [![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=master)](https://travis-ci.org/SpaceVim/SpaceVim) [![Build status](https://ci.appveyor.com/api/projects/status/eh3t5oph70abp665/branch/master?svg=true)](https://ci.appveyor.com/project/wsdjeg/spacevim/branch/master) @@ -7,46 +15,27 @@ [![Version](https://img.shields.io/badge/version-1.6.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 配置集合,以模块的方式组织管理插件以 +![welcome page](https://user-images.githubusercontent.com/13142418/89103568-5ad59480-d445-11ea-9745-bd53e668b956.png) + +[SpaceVim](https://spacevim.org/cn/) 是一个社区驱动的模块化 Vim/Neovim 配置集合,以模块的方式组织管理插件以 及相关配置,为不同的语言开发量身定制了相关的开发模块,该模块提供代码自动补全, 语法检查、格式化、调试、REPL 等特性。用户仅需载入相关语言的模块即可得到一个开箱 即用的 Vim-IDE。 -官网: +当前最新的稳定版为[v1.5.0](https://spacevim.org/SpaceVim-release-v1.5.0/),[following-HEAD](https://github.com/SpaceVim/SpaceVim/wiki/Following-HEAD) 页面罗列了 +master 分支最新的更新以及变动。 -Github: +**推荐阅读:** -码云: - -![welcome-page](https://user-images.githubusercontent.com/13142418/89103568-5ad59480-d445-11ea-9745-bd53e668b956.png) - -推荐阅读: - -- [入门指南](https://spacevim.org/cn/quick-start-guide) -- [用户文档](https://spacevim.org/cn/documentation) -- [可用模块](https://spacevim.org/cn/layers) - - - -- [最新特性](#最新特性) - - [多光标 Iedit 模式](#多光标-iedit-模式) - - [高亮光标下的函数](#高亮光标下的函数) - - [实时代码检索](#实时代码检索) - - [快捷键辅助导航](#快捷键辅助导航) - - [快捷键描述系统](#快捷键描述系统) - - [异步插件管理器](#异步插件管理器) -- [安装](#安装) - - [Linux 或 macOS](#linux-或-macos) - - [Windows](#windows) -- [捐助 SpaceVim](#捐助-spacevim) - - +- [入门指南](https://spacevim.org/cn/quick-start-guide/) +- [用户文档](https://spacevim.org/cn/documentation/) +- [可用模块](https://spacevim.org/cn/layers/) ## 最新特性 以下为 SpaceVim 中最新实现的一些特性: -### 多光标 Iedit 模式 +**多光标 Iedit 模式:** SpaceVim 内置了一种特殊的模式,Iedit 模式,这种模式提供了多光标支持,不同于已有插件的实现, 该模式支持两种状态:`iedit-Normal` 和 `iedit-Insert`。默认情况下,多光标输入时,`iedit-normal` @@ -54,7 +43,7 @@ SpaceVim 内置了一种特殊的模式,Iedit 模式,这种模式提供了 ![iedit mode](https://user-images.githubusercontent.com/13142418/44941560-be2a9800-add2-11e8-8fa5-e6118ff9ddcb.gif) -### 高亮光标下的函数 +**高亮光标下的函数:** SpaceVim 支持高亮当前光标函数,并且启动一个特殊模式,在该模式下可以快捷地切换高亮区域 (方法内、屏幕内、整个文件内),并且可以快速在高亮函数间跳转、切换高亮状态(高亮、取消高亮), @@ -62,21 +51,21 @@ SpaceVim 支持高亮当前光标函数,并且启动一个特殊模式,在 ![highlight cursor symbol](https://user-images.githubusercontent.com/13142418/36210381-e6dffde6-1163-11e8-9b35-0bf262e6f22b.gif) -### 实时代码检索 +**实时代码检索:** SpaceVim 自带的 FlyGrep 这个插件可以根据输入实时搜索项目代码,当然需要借助后台搜索工具, 目前支持的工具有:`ag`, `rg`, `ack`, `pt` 和 `grep`,用户可任意选择一个喜欢的工具。 ![searching project](https://user-images.githubusercontent.com/13142418/35278709-7856ed62-0010-11e8-8b1e-e6cc6374b0dc.gif) -### 快捷键辅助导航 +**快捷键辅助导航:** 在 SpaceVim 中,所有快捷键都有导航系统,你不需要记忆任何快捷键。初次使用时可根据快捷键提示进行操作。当按下空格键或者 `g`、`z` 以及 `s` 按键时,导航就会自动出现。当你记住了快捷键,输入比较快时,导航则不会出现。 ![mapping guide](https://user-images.githubusercontent.com/13142418/35568184-9a318082-058d-11e8-9d88-e0eafd1d498d.gif) -### 快捷键描述系统 +**快捷键描述系统** 通过快捷键描述系统,你可以清楚的了解到一个快捷键的功能,并且可以快速跳转到快捷键定义的位置; 比如,通过 `SPC h d k` 启动快捷键描述系统,然后按下所需描述快捷键 `SPC b n`,就会弹出一个描述 @@ -84,7 +73,7 @@ SpaceVim 自带的 FlyGrep 这个插件可以根据输入实时搜索项目代 ![describe key bindings](https://user-images.githubusercontent.com/13142418/35568829-e3c8e74c-058f-11e8-8fa8-c0e046d8add3.gif) -### 异步插件管理器 +[**异步插件管理器:**](https://spacevim.org/cn/asynchronous-plugin-manager/) SpaceVim 利用了 Vim 8 和 Neovim 最新的异步机制,实现了异步插件下载及更新,而插件运行管理采用的是 [dein.vim](https://github.com/Shougo/dein.vim/)。 @@ -92,28 +81,17 @@ SpaceVim 利用了 Vim 8 和 Neovim 最新的异步机制,实现了异步插 想要获取更多关于 SpaceVim 的最新特性,请关注 [SpaceVim 官方博客](https://spacevim.org/blog/) -## 安装 - -### Linux 或 macOS - -```bash -curl -sLf https://spacevim.org/cn/install.sh | bash -``` - -安装结束后,初次打开 `Vim` 或者 `gVim` 时,SpaceVim 会**自动**下载并安装插件。 - -如果需要获取安装脚本的帮助信息,可以执行如下命令,包括定制安装、更新和卸载等。 - -```bash -curl -sLf https://spacevim.org/cn/install.sh | bash -s -- -h -``` - -### Windows - -Windows 下最快捷的安装方法是下载安装脚本 [install.cmd](https://spacevim.org/cn/install.cmd) 并运行。 - -## 捐助 SpaceVim +## 支持 SpaceVim | 微信 | 支付宝 | | -------------------------------------------------------- | ---------------------------------------------------------- | | | | + +## 鸣谢 + +- [@Gabirel](https://github.com/Gabirel) 的 [《Hack-SpaceVim》](https://github.com/Gabirel/Hack-SpaceVim) +- [@everettjf](https://github.com/everettjf) 的 [《SpaceVimTutorial》](https://everettjf.gitbooks.io/spacevimtutorial/content/) +- [vimdoc](https://github.com/google/vimdoc):自动生成帮助文件 +- SpaceVim 中所使用所有插件的作者 + + diff --git a/README.md b/README.md index 51c6e6316..8dc1dabe9 100644 --- a/README.md +++ b/README.md @@ -19,23 +19,6 @@ ![welcome page](https://user-images.githubusercontent.com/13142418/89103568-5ad59480-d445-11ea-9745-bd53e668b956.png) -**Table of context** - - - -- [Instructions](#instructions) - - [Features](#features) -- [Getting help](#getting-help) -- [Contributing](#contributing) - - [Project layout](#project-layout) -- [Support SpaceVim](#support-spacevim) -- [License](#license) -- [Credits & Thanks](#credits--thanks) - - - -## Instructions - [SpaceVim](https://spacevim.org/) 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. @@ -43,55 +26,14 @@ The last release is [v1.5.0](https://spacevim.org/SpaceVim-release-v1.5.0/), che **See the followings below for more information:** -- [Quick Start Guide](https://spacevim.org/quick-start-guide/): a simple guide for Beginners. +- [Quick Start Guide](https://spacevim.org/quick-start-guide/): A simple guide for Beginners. - [Documentation](https://spacevim.org/documentation/): The full documentation about using SpaceVim. - [Available Layers](https://spacevim.org/layers/): A list of all available layers included in SpaceVim. -### Features +## Features 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: - -```toml -# This is basic configuration example for SpaceVim. - -# All SpaceVim options below [options] snippet. -[options] - # Set SpaceVim theme. By default colorscheme layer is not loaded. - # If you want to use more colorschemes, please load the colorscheme - # layer. - colorscheme = "gruvbox" - colorscheme_bg = "dark" - # Disable guicolors in basic mode, many terminal do not support 24bit - # true colors - enable_guicolors = false - # Disable statusline separator, if you want to use other value, please - # install nerd fonts - statusline_separator = "nil" - statusline_inactive_separator = "bar" - buffer_index_type = 4 - windows_index_type = 3 - enable_tabline_ft_icon = false - enable_statusline_mode = false - statusline_unicode_symbols = false - # Enable Vim compatible mode, avoid changing origin Vim key bindings - vimcompatible = true - -# Enable autocomplete layer -[[layers]] - name = 'autocomplete' - auto-completion-return-key-behavior = "complete" - auto-completion-tab-key-behavior = "cycle" - -[[layers]] - name = 'shell' - default_position = 'top' - default_height = 30 -``` - **Iedit mode** SpaceVim uses a powerful iedit mode to quick edit multiple occurrences of a symbol or selection. Two new modes:`iedit-Normal`/`iedit-Insert`. @@ -128,7 +70,7 @@ Use SPC h d k to get the help description of a key binding, and `gd` ![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/) +[**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 @@ -136,40 +78,13 @@ Create an UI for [dein.vim](https://github.com/Shougo/dein.vim/) - the best asyn For more features, please read [SpaceVim's Blog](https://spacevim.org/blog/) +## Support SpaceVim -## Getting help - -If you run into some problems installing, configuring, or using SpaceVim, -checkout the [Getting help guidelines](https://github.com/SpaceVim/SpaceVim/wiki/Getting-help) in the wiki. - - -## Contributing - -This project exists thanks to all the people who [contributed](CONTRIBUTING.md), We are thankful for any contributions from the community. +This project exists thanks to all the people who [contributed](CONTRIBUTING.md), +We are thankful for any contributions from the community. -### Project layout - -```txt -├─ .ci/ build automation -├─ .github/ issue/PR templates -├─ .SpaceVim.d/ project specific configuration -├─ autoload/SpaceVim.vim SpaceVim core file -├─ autoload/SpaceVim/api/ Public APIs -├─ autoload/SpaceVim/layers/ available layers -├─ autoload/SpaceVim/plugins/ buildin plugins -├─ autoload/SpaceVim/mapping/ mapping guide -├─ doc/ help(cn/en) -├─ docs/ website(cn/en) -├─ wiki/ wiki(cn/en) -├─ bin/ executable -├─ bundle/ forked repos -└─ test/ tests -``` - -## 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. @@ -179,21 +94,11 @@ If you want to show your support financially you can buy a drink for the maintai Buy Me a Coffee at ko-fi.com -## License - -The license is GPLv3 for all the parts of SpaceVim. This includes: - -- The initialization and core files. -- All the layer files. -- The documentation - ## Credits & Thanks - [@Gabirel](https://github.com/Gabirel) and his [Hack-SpaceVim](https://github.com/Gabirel/Hack-SpaceVim) - [@everettjf](https://github.com/everettjf) and his [SpaceVimTutorial](https://everettjf.gitbooks.io/spacevimtutorial/content/) - [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. diff --git a/docs/_posts/2017-08-11-Asynchronous-plugin-manager.md b/docs/_posts/2017-08-11-asynchronous-plugin-manager.md similarity index 95% rename from docs/_posts/2017-08-11-Asynchronous-plugin-manager.md rename to docs/_posts/2017-08-11-asynchronous-plugin-manager.md index b8bd2711a..00649f626 100644 --- a/docs/_posts/2017-08-11-Asynchronous-plugin-manager.md +++ b/docs/_posts/2017-08-11-asynchronous-plugin-manager.md @@ -3,6 +3,7 @@ title: "Asynchronous plugin manager" categories: [feature, blog] description: "Use dein as default plugin manager, Provides a UI for dein, Install and update plugin asynchronously, Show process status on the fly" image: https://user-images.githubusercontent.com/13142418/80597767-e1e82a80-8a5a-11ea-85ad-031a6f3240f0.gif +redirect_from: "/Asynchronous-plugin-manager/" commentsID: "Asynchronous plugin manager" comments: true --- diff --git a/docs/_posts/2019-07-16-Asynchronous-todo-manager.md b/docs/_posts/2019-07-16-asynchronous-todo-manager.md similarity index 94% rename from docs/_posts/2019-07-16-Asynchronous-todo-manager.md rename to docs/_posts/2019-07-16-asynchronous-todo-manager.md index 431330991..868c4df31 100644 --- a/docs/_posts/2019-07-16-Asynchronous-todo-manager.md +++ b/docs/_posts/2019-07-16-asynchronous-todo-manager.md @@ -4,6 +4,7 @@ categories: [feature_cn, blog_cn] description: "异步TODO列表管理器,查询当前项目所有的TODO项目,展示TODO标签和标题。" image: https://user-images.githubusercontent.com/13142418/61462920-0bd9d000-a9a6-11e9-8e1f-c70d6ec6ca1e.png permalink: /cn/:title/ +redirect_from: "/cn/Asynchronous-todo-manager/" lang: zh type: article comments: true diff --git a/docs/_posts/2019-07-17-Asynchronous-todo-manager.md b/docs/_posts/2019-07-17-Asynchronous-todo-manager.md deleted file mode 100644 index b18b95482..000000000 --- a/docs/_posts/2019-07-17-Asynchronous-todo-manager.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Asynchronous todo manager" -categories: [feature, blog] -description: "Asynchronous TODO list manager that queries all TODO items in the current project, display TODO tags and titles." -image: https://user-images.githubusercontent.com/13142418/61462920-0bd9d000-a9a6-11e9-8e1f-c70d6ec6ca1e.png -commentsID: "Asynchronous todo manager" -comments: true ---- - -# [Blogs](../blog/) >> Asynchronous todo manager - -{{ page.date | date_to_string }} - - -The built-in asynchronous todo manager provides the ability to queries and displays all the todo items in -in current project. the default key bidning is `SPC a o`, and the default tags is: - `'fixme', 'question', 'todo', 'idea'` - -![todo manager](https://user-images.githubusercontent.com/13142418/61462920-0bd9d000-a9a6-11e9-8e1f-c70d6ec6ca1e.png) - -This plugin also has been detached into [vim-todo](https://github.com/wsdjeg/vim-todo/), you can use it without SpaceVim. - diff --git a/docs/_posts/2020-09-28-asynchronous-plugin-manager.md b/docs/_posts/2020-09-28-asynchronous-plugin-manager.md new file mode 100644 index 000000000..72a33132c --- /dev/null +++ b/docs/_posts/2020-09-28-asynchronous-plugin-manager.md @@ -0,0 +1,23 @@ +--- +title: "Vim 异步插件管理器" +categories: [blog_cn, feature_cn] +description: "使用 dein 作为默认插件管理器,提供一个可视化的插件管理界面。" +permalink: /cn/:title/ +lang: zh +type: article +comments: true +image: https://user-images.githubusercontent.com/13142418/80597767-e1e82a80-8a5a-11ea-85ad-031a6f3240f0.gif +commentsID: "VIM 异步插件管理器" +--- + +# [Blogs](../blog/) >> VIM 异步插件管理器 + +{{ page.date | date_to_string }} + +SpaceVim 使用 `dein` 作为默认的插件管理器,并且提供一个可视化的插件管理界面。 + +![dein ui](https://user-images.githubusercontent.com/13142418/80597767-e1e82a80-8a5a-11ea-85ad-031a6f3240f0.gif) + +在更新插件的过程中,如果提示插件跟新失败,错误消息会在插件名称后方展示。 +同时,可以在插件上按下快捷键 `g r`,进行更新,或者使用快捷键 `g f` +打开一个终端,并且定位到插件所在的目录。