From ea7134702c21d9bd55457ba8aeed135a7915e2c8 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Tue, 7 May 2024 09:25:50 +0800 Subject: [PATCH] docs(website): update doc --- docs/cn/documentation.md | 74 ++++++++-------------------------------- docs/documentation.md | 64 ++++++---------------------------- 2 files changed, 25 insertions(+), 113 deletions(-) diff --git a/docs/cn/documentation.md b/docs/cn/documentation.md index ded309dbe..3f9aec6d6 100644 --- a/docs/cn/documentation.md +++ b/docs/cn/documentation.md @@ -9,11 +9,9 @@ lang: zh -- [核心思想](#核心思想) -- [显著特性](#显著特性) +- [突出特点](#突出特点) - [运行截图](#运行截图) -- [基本概念](#基本概念) -- [适用人群](#适用人群) +- [新的概念](#新的概念) - [更新回滚](#更新回滚) - [自身更新](#自身更新) - [更新插件](#更新插件) @@ -100,43 +98,15 @@ lang: zh -## 核心思想 +## 突出特点 -四大核心思想：记忆辅助、可视化交互、一致性、社区驱动。 - -如果违背了以上四大核心思想，我们将会尽力修复。 - -**记忆辅助** - -所有快捷键，根据其功能的不同分为不同的组， -以相应的按键作为前缀，例如 `b` 为 buffer 相关快捷键前缀， -`p` 为 project 相关快捷键前缀，`s` 为 search 相关快捷键前缀， -`h` 为 help 相关快捷键前缀。 - -**可视化交互** - -创新的实时快捷键辅助系统，以及查询系统， -方便快捷查询到可用的模块、插件以及其它更多信息。 - -**一致性** - -相似的功能使用同样的快捷键，这在 SpaceVim 中随处可见。 -这得益于明确的约定。其它模块的文档都以此为基础。 - -**社区驱动** - -社区驱动，保证了 bug 修复的速度，以及新特性更新的速度。 - -## 显著特性 - -- **详细的文档：** 在 SpaceVim 中通过 `:h SpaceVim` 来访问 SpaceVim 帮助文档。 -- **优雅简洁的界面：** 你将会喜欢这样的优雅而实用的界面。 -- **确保手指不离开主键盘区域：** 使用空格键（`SPC`）作为前缀键，合理组织快捷键，确保手指不离开主键盘区域。 -- **快捷键辅助系统：** 所有快捷键无需记忆，当输入出现停顿，会实时提示可用按键及其功能。 -- **更快的启动时间：** 得益于 dein.vim, 90% 的插件都是按需载入的。 +- **模块化：** 使用[模块](../layers/)的概念组织插件。 +- **兼容性 API：** 提供一系列[兼容API](../api/)，兼容 Neovim 和 Vim。 +- **详细的文档：** 所有功能配置皆在 `:h SpaceVim` 中有体现。 +- **更好的使用体验：** 大部分核心插件使用 Lua 重写以提高效率。 +- **优雅简洁的界面：** 界面元素经过精心设计。 +- **快捷键辅助系统：** 快捷键使用助记符组织，实时提示按键功能。 - **更少的肌肉损伤：** 频繁使用空格键，取代 `ctrl`，`shift` 等按键，大大减少了手指的肌肉损伤。 -- **更易扩展：** 依照一些[约定](http://spacevim.org/cn/development/)，很容易将现有的插件集成到 SpaceVim 中来。 -- **完美支持 Neovim:** 得益于 Neovim 的 remote 插件以及异步 API，运行在 Neovim 下将有更加完美的体验。 ## 运行截图 @@ -146,15 +116,13 @@ lang: zh **工作界面** -![work-flow](https://img.spacevim.org/6af0b728-2a9d-11e7-9721-d2a694dde1a8.png) +![work-flow](https://img.spacevim.org/workflow.png) -Neovim 运行在 iTerm2 上，采用 SpaceVim，配色为：_base16-solarized-dark_ +- 主题：one +- 窗口: Git remotes, outline, Todos, Code runner, Terminal, file explore. +- 代码补全插件: nvim-cmp -展示了一个通用的前端开发界面，用于开发：JavaScript (jQuery), SASS, 和 PHP buffers。 - -图中包含了一个 Neovim 的终端，一个语法树窗口，一个文件树窗口以及一个 TernJS 定义窗口 - -## 基本概念 +## 新的概念 **临时快捷键菜单** @@ -167,20 +135,6 @@ SpaceVim 根据需要定义了很多临时快捷键， ![Move Text Transient State](https://img.spacevim.org/28489559-4fbc1930-6ef8-11e7-9d5a-716fe8dbb881.png) -## 适用人群 - -之所以开发 SpaceVim 这一项目，目的在于维护一个模块化、开箱即用、稳定的 Vim 开发环境， -尽最大可能地处理好各种插件以及工具之间的依赖关系，为 SpaceVim 用户节省搜索、配置、 -学习插件的时间。 - -因此，SpaceVim 适合于： - -- 初级 Vim 用户 -- 追求优雅界面 -- 尽可能减少[肌肉损伤](http://en.wikipedia.org/wiki/Repetitive_strain_injury) -- 追求简单但是可高度配置系统的 Vim 用户 -- 追求统一的编程环境 - ## 更新回滚 ### 自身更新 diff --git a/docs/documentation.md b/docs/documentation.md index 42024cb23..bad9461d3 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -7,11 +7,9 @@ description: "General documentation about how to use SpaceVim, including the qui -- [Core Pillars](#core-pillars) -- [Highlighted features](#highlighted-features) +- [Highlighted Features](#highlighted-features) - [Screenshots](#screenshots) -- [Concepts](#concepts) -- [Who can benefit from this?](#who-can-benefit-from-this) +- [New Concepts](#new-concepts) - [Update and Rollback](#update-and-rollback) - [Update SpaceVim itself](#update-spacevim-itself) - [Update plugins](#update-plugins) @@ -97,47 +95,15 @@ description: "General documentation about how to use SpaceVim, including the qui -## Core Pillars +## Highlighted Features -Four core pillars: Mnemonic, Discoverable, Consistent and “Crowd-Configured”. - -If any of these core pillars are violated open an issue, and we’ll try our best to fix it. - -**Mnemonic** - -Key bindings are organized using mnemonic prefixes, -like b for buffer, p for project, s for search, h for help, -etc… - -**Discoverable** - -Innovative real-time display of available key bindings. -Simple query system to quickly find available layers, -packages, and more. - -**Consistent** - -Similar functionalities have the same key bindings -everywhere thanks to a clearly defined set of conventions. -Documentation is mandatory for any layer that ships with -SpaceVim. - -**Crowd-Configured** - -Community-driven configuration provides curated -packages tuned by power users and bugs are fixed quickly. - -## Highlighted features - -- **Modularization:** plugins and functions are organized in [layers](https://spacevim.org/layers/). -- **Compatible api:** a series of [compatible APIs](https://spacevim.org/api/) for Vim/Neovim. -- **Great documentation:** online [documentation](https://spacevim.org/documentation/) and `:h SpaceVim`. -- **Better experience:** rewrite core plugins using lua -- **Beautiful UI:** you'll love the awesome UI and its useful features. -- **Mnemonic key bindings:** key binding guide will be displayed automatically -- **Fast boot time:** Lazy-load 90% of plugins with [dein.vim](https://github.com/Shougo/dein.vim) -- **Lower the risk of RSI:** by heavily using the space bar instead of modifiers. -- **Consistent experience:** consistent experience between terminal and gui +- **Modularization:** Plugins are organized in [layers](https://spacevim.org/layers/). +- **Compatible API:** A series of [compatible API](https://spacevim.org/api/) for Vim/Neovim. +- **Great documentation:** Everything is documented in `:h SpaceVim`. +- **Better experience:** Most of the core plugins have been rewritten using Lua. +- **Beautiful UI:** The interface has been carefully designed. +- **Mnemonic key bindings:** Key bindings are organized using mnemonic prefixes. +- **Lower the risk of RSI:** Heavily using the `` key instead of modifiers. ## Screenshots @@ -153,7 +119,7 @@ packages tuned by power users and bugs are fixed quickly. - windows: Git remotes, outline, Todos, Code runner, Terminal, file explore. - code completion engine: nvim-cmp -## Concepts +## New Concepts **Transient-states** @@ -168,14 +134,6 @@ Move Text Transient State: ![Move Text Transient State](https://img.spacevim.org/28489559-4fbc1930-6ef8-11e7-9d5a-716fe8dbb881.png) -## Who can benefit from this? - -- **Elementary** Vim users. -- Vim users pursuing a beautiful appearance. -- Vim users wanting to lower the [risk of RSI](http://en.wikipedia.org/wiki/Repetitive_strain_injury). -- Vim users wanting to learn a different way to edit files. -- Vim users wanting a simple but deep configuration system. - ## Update and Rollback ### Update SpaceVim itself