Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 13:30:05 +08:00
Code Issues Projects Releases Wiki Activity

Update documentation (#1765)

Browse Source
This commit is contained in:
Wang Shidong 2018-05-31 08:17:38 -05:00 committed by GitHub
parent bb75c310a2
commit 5ea92078f3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 807 additions and 1207 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/_posts/2017-12-30-SpaceVim-release-v0.6.0.md
View File

@ -1,7 +1,7 @@
---
title: SpaceVim release v0.6.0
categories: [changelog, blog]
excerpt: "Many new features come out with v0.6.0"
excerpt: "Many new features come out with v0.6.0, including c/cpp suport and code runner"
type: NewsArticle
image: https://user-images.githubusercontent.com/13142418/33793078-3446cb6e-dc76-11e7-9998-376a355557a4.png
comments: true

1789
docs/cn/documentation.md
View File

File diff suppressed because it is too large Load Diff

94
docs/cn/roadmap.md
View File

@ -1,18 +1,36 @@
---
title: "Roadmap"
description: "The roadmap and milestones define the project direction and priorities."
title: "设计蓝图"
description: "SpaceVim 设计蓝图和里程碑， 这决定了 SpaceVim 的开发方向和特性实现的有先顺序。"
lang: cn
---
# Roadmap
# 设计蓝图
The roadmap and [milestones](https://github.com/SpaceVim/SpaceVim/milestones) define the project direction and priorities.
SpaceVim 的设计蓝图和[里程碑](https://github.com/SpaceVim/SpaceVim/milestones)决定了该项目的开发方向以及所有特性实现的有先顺序。
## Next
### [0.7](https://github.com/SpaceVim/SpaceVim/milestone/10)
<!-- vim-markdown-toc GFM -->
## Meta
- [下一个版本](#下一个版本)
- [0.8](#08)
- [版本说明](#版本说明)
- [Completed](#completed)
- [v0.1.0](#v010)
- [v0.2.0](#v020)
- [v0.3.0](#v030)
- [v0.3.1](#v031)
- [v0.4.0](#v040)
- [v0.5.0](#v050)
- [v0.6.0](#v060)
- [v0.7.0](#v070)
<!-- vim-markdown-toc -->
## 下一个版本
### [0.8](https://github.com/SpaceVim/SpaceVim/milestone/11)
## 版本说明
There are release milestones and meta milestones ("buckets").
@ -22,39 +40,55 @@ There are release milestones and meta milestones ("buckets").
- [todo](https://github.com/SpaceVim/SpaceVim/milestone/4) is a bucket for triaged tickets which should be on the roadmap but cannot yet be assigned to a concrete milestone.
- [unplanned](https://github.com/SpaceVim/SpaceVim/milestone/5) is a bucket for low-priority items or items lacking a feasible path to completion.
<!-- call SpaceVim#dev#roadmap#updateCompletedItems() -->
<!-- SpaceVim roadmap completed items start -->
## Completed
### [0.6](https://github.com/SpaceVim/SpaceVim/milestone/9)
### [v0.1.0](https://github.com/SpaceVim/SpaceVim/milestone/1)
see the release note: [V0.5.0](https://github.com/SpaceVim/SpaceVim/milestone/9)
Will release 0.1 at 2017-01-27, as you know, it is the last day of this year in chinese.
### [0.5](https://github.com/SpaceVim/SpaceVim/milestone/8)
release note: [v0.1.0](http://spacevim.org/SpaceVim-release-v0.1.0/)
see the release note: [V0.5.0](https://github.com/SpaceVim/SpaceVim/milestone/9)
### [v0.2.0](https://github.com/SpaceVim/SpaceVim/milestone/2)
### [0.4](https://github.com/SpaceVim/SpaceVim/milestone/7)
1. Many language support
2. Improve default layer
3. finish document
- Improve git work flow
- completion in commit message buffer
- manager github issues annd PRs
- Improve autocomplete layer
release note: [v0.2.0](http://spacevim.org/SpaceVim-release-v0.2.0/)
### [0.3](https://github.com/SpaceVim/SpaceVim/milestone/3)
### [v0.3.0](https://github.com/SpaceVim/SpaceVim/milestone/3)
- statusline with mode support
- Plugin manager ui for dein
- Improve mapping guide
- Tabs manager
- Layers manager
- SpaceVim api
- plugin manager ui ( for dein)
### [0.2](https://github.com/SpaceVim/SpaceVim/milestone/2)
release note: [v0.3.0](http://spacevim.org/SpaceVim-release-v0.3.0/)
- Mnemonic key bindings
- Denite support
- Unite work flow
- Windows support
### [v0.3.1](https://github.com/SpaceVim/SpaceVim/milestone/6)
### [0.1](https://github.com/SpaceVim/SpaceVim/milestone/1)
features need to be implemented just after v0.3.0 has been released.
- The primary goal of the 0.1 release ("first public release") is to reach a stable, functional baseline that can be built upon and used as a benchmark for further progress.
- Layers feature
release note: [v0.3.1](http://spacevim.org/SpaceVim-release-v0.3.1/)
### [v0.4.0](https://github.com/SpaceVim/SpaceVim/milestone/7)
release note: [v0.4.0](http://spacevim.org/SpaceVim-release-v0.4.0/)
### [v0.5.0](https://github.com/SpaceVim/SpaceVim/milestone/8)
release note: [v0.5.0](http://spacevim.org/SpaceVim-release-v0.5.0/)
### [v0.6.0](https://github.com/SpaceVim/SpaceVim/milestone/9)
release note: [v0.6.0](http://spacevim.org/SpaceVim-release-v0.6.0/)
### [v0.7.0](https://github.com/SpaceVim/SpaceVim/milestone/10)
- Improve all the lang#\* layers
release note: [v0.7.0](http://spacevim.org/SpaceVim-release-v0.7.0/)
<!-- SpaceVim roadmap completed items end -->

125
docs/documentation.md
View File

@ -58,7 +58,6 @@ description: "General documentation about how to using SpaceVim, including the q
- [Open file with file tree.](#open-file-with-file-tree)
- [Commands starting with `g`](#commands-starting-with-g)
- [Commands starting with `z`](#commands-starting-with-z)
- [Auto-saving](#auto-saving)
- [Searching](#searching)
- [With an external tool](#with-an-external-tool)
- [Useful key bindings](#useful-key-bindings)
@ -116,7 +115,7 @@ Community-driven configuration provides curated packages tuned by power users an
## Highlighted features
- **Great documentation:** access documentation in Vim with
- **Great documentation:** access documentation in SpaceVim with
`:h SpaceVim`.
- **Minimalistic and nice graphical UI:** you'll love the awesome UI and its useful features.
- **Keep your fingers on the home row:** for quicker editing with support for QWERTY and BEPO layouts.
@ -212,9 +211,10 @@ if you want to add custom `SPC` prefix key bindings, you can add this to SpaceVi
call SpaceVim#custom#SPCGroupName(['G'], '+TestGroup')
call SpaceVim#custom#SPC('nore', ['G', 't'], 'echom 1', 'echomessage 1', 1)
```
### Vim Compatible Mode
This a list of different key bindings between SpaceVim and origin vim.
This a list of different key bindings between SpaceVim and origin vim. If you still want to use this origin function, you can enable vimcompatible mode, via `vimcompatible = true` in `[options]` section.
- The `s` key does replace cursor char, but in SpaceVim it is the `Window` key bindings specific leader key by default (which can be set on another key binding in dotfile). If you still prefer the origin function of `s`, you can use an empty string to disable this feature.
@ -232,8 +232,6 @@ the option is `g:spacevim_windows_smartclose`, default value is `q`. If you stil
[Send a PR](http://spacevim.org/development/) to add the differences you found in this section.
If you still want to use this origin function, you can enable vimcompatible mode, via `vimcompatible = 1` in `[options]` section.
### Private Layers
This section is an overview of layers. A more extensive introduction to writing configuration layers can be found in [SpaceVim's layers page](http://spacevim.org/layers/) (recommended reading!).
@ -265,7 +263,6 @@ Move Text Transient State:
![Move Text Transient State](https://user-images.githubusercontent.com/13142418/28489559-4fbc1930-6ef8-11e7-9d5a-716fe8dbb881.png)
## Interface elements
SpaceVim has a minimalistic and distraction free UI:
@ -288,12 +285,12 @@ the variable colorschemes. For instance, to specify `desert`:
colorscheme_bg = "dark"
```
| Mappings | Description |
| ------------------ | -------------------------------------------------------------- |
| Mappings | Description |
| --------- | -------------------------------------------------------------- |
| `SPC T n` | switch to next random colorscheme listed in colorscheme layer. |
| `SPC T s` | select a theme using a unite buffer. |
all the included colorscheme can be found in [colorscheme layer](http://spacevim.org/layers/colorscheme/).
all the included colorscheme can be found in [colorscheme layer](layers/colorscheme/).
**NOTE**:
@ -325,23 +322,23 @@ Also note that changing this value has no effect if you are running Vim/Neovim i
Some UI indicators can be toggled on and off (toggles start with t and T):
| Key Binding | Description |
| ----------- | ----------------------------------------------------------------- |
| `SPC t 8` | highlight any character past the 80th column |
| Key Binding | Description |
| ----------- | -------------------------------------------------------- |
| `SPC t 8` | highlight any character past the 80th column |
| `SPC t f` | display the fill column (by default `max_column` is 120) |
| `SPC t h h` | toggle highlight of the current line |
| `SPC t h i` | toggle highlight indentation levels (TODO) |
| `SPC t h c` | toggle highlight indentation current column |
| `SPC t h s` | toggle syntax highlighting |
| `SPC t i` | toggle indentation guide at point |
| `SPC t n` | toggle line numbers |
| `SPC t b` | toggle background |
| `SPC t t` | open tabs manager |
| `SPC T ~` | display ~ in the fringe on empty lines |
| `SPC T F` | toggle frame fullscreen |
| `SPC T f` | toggle display of the fringe |
| `SPC T m` | toggle menu bar |
| `SPC T t` | toggle tool bar |
| `SPC t h h` | toggle highlight of the current line |
| `SPC t h i` | toggle highlight indentation levels (TODO) |
| `SPC t h c` | toggle highlight indentation current column |
| `SPC t h s` | toggle syntax highlighting |
| `SPC t i` | toggle indentation guide at point |
| `SPC t n` | toggle line numbers |
| `SPC t b` | toggle background |
| `SPC t t` | open tabs manager |
| `SPC T ~` | display ~ in the fringe on empty lines |
| `SPC T F` | toggle frame fullscreen |
| `SPC T f` | toggle display of the fringe |
| `SPC T m` | toggle menu bar |
| `SPC T t` | toggle tool bar |
### Statusline
@ -356,6 +353,10 @@ The `core#statusline` layer provide a heavily customized powerline with the foll
- toggle minor mode lighters
- show VCS information (branch, hunk summary) (need `git` and `VersionControl` layer)
| Key bindings | Description |
| ------------ | -------------------------------------------- |
| `SPC [1-9]` | jump to the windows with the specific number |
Reminder of the color codes for the states:
| Mode | Color |
@ -382,24 +383,20 @@ Some elements can be dynamically toggled:
| `SPC t m T` | toggle the mode line itself |
| `SPC t m v` | toggle the version control info |
**Powerline font installation:**
**nerd font installation:**
By default SpaceVim use [DejaVu Sans Mono for Powerline](https://github.com/powerline/fonts/tree/master/DejaVuSansMono), to make statusline render correctly, you need to install the font. [powerline extra symbols](https://github.com/ryanoasis/powerline-extra-symbols) also should be installed.
By default SpaceVim use nerd-fonts, please read the documentation of nerd fonts.
**syntax checking integration:**
When syntax checking minor mode is enabled, a new element appears showing the number of errors, warnings.
syntax checking integration in statusline.
**Search index integration:**
Search index shows the number of occurrence when performing a search via `/` or `?`. SpaceVim integrates nicely the search status by displaying it temporarily when n or N are being pressed. See the 20/22 segment on the screenshot below.
![search status](https://cloud.githubusercontent.com/assets/13142418/26313080/578cc68c-3f3c-11e7-9259-a27419d49572.png)
_search index in statusline_
**Battery status integration:**
_acpi_ displays the percentage of total charge of the battery as well as the time remaining to charge or discharge completely the battery.
@ -416,10 +413,10 @@ all the colors based on the current colorscheme
**Statusline separators:**
It is possible to easily customize the statusline separator by setting the `g:spacevim_statusline_separator` variable in your custom configuration file and then redraw the statusline. For instance if you want to set back the separator to the well-known arrow separator add the following snippet to your configuration file:
It is possible to easily customize the statusline separator by setting the `statusline_separator` variable in your custom configuration file and then redraw the statusline. For instance if you want to set back the separator to the well-known arrow separator add the following snippet to your configuration file:
```vim
let g:spacevim_statusline_separator = 'arrow'
```toml
statusline_separator = 'arrow'
```
here is an exhaustive set of screenshots for all the available separator:
@ -436,7 +433,7 @@ here is an exhaustive set of screenshots for all the available separator:
The minor mode area can be toggled on and off with `SPC t m m`
Unicode symbols are displayed by default. Setting the variable `g:spacevim_statusline_unicode_symbols` to 0 in your custom configuration file will display ASCII characters instead (may be useful in terminal if you cannot set an appropriate font).
Unicode symbols are displayed by default. Add `statusline_unicode_symbols = false` to your custom configuration file, statusline will display ASCII characters instead (may be useful in terminal if you cannot set an appropriate font).
The letters displayed in the statusline correspond to the key bindings used to toggle them.
@ -491,20 +488,20 @@ endfunction
this example is for gruvbox colorscheme, if you want to use same colors when
switch between different colorschemes, you may need to set
`g:spacevim_custom_color_palette` in your custom configuration file. for example:
`custom_color_palette` in your custom configuration file. for example:
```vim
let g:spacevim_custom_color_palette = [
\ ['#282828', '#a89984', 246, 235],
\ ['#a89984', '#504945', 239, 246],
\ ['#a89984', '#3c3836', 237, 246],
\ ['#665c54', 241],
\ ['#282828', '#83a598', 235, 109],
\ ['#282828', '#fe8019', 235, 208],
\ ['#282828', '#8ec07c', 235, 108],
\ ['#282828', '#689d6a', 235, 72],
\ ['#282828', '#8f3f71', 235, 132],
\ ]
```toml
custom_color_palette = [
["#282828", "#a89984", 246, 235],
["#a89984", "#504945", 239, 246],
["#a89984", "#3c3836", 237, 246],
["#665c54", 241],
["#282828", "#83a598", 235, 109],
["#282828", "#fe8019", 235, 208],
["#282828", "#8ec07c", 235, 108],
["#282828", "#689d6a", 235, 72],
["#282828", "#8f3f71", 235, 132],
]
```
### tabline
@ -776,7 +773,7 @@ then use `<Tab>` or `<Up>` and `<Down>` to select the mapping, press `<Enter>` w
Denite/Unite is powerful tool to unite all interfaces. it was meant to be like [Helm](https://github.com/emacs-helm/helm) for Vim. These mappings is for getting help info about functions, variables etc:
| Mappings | Description |
| --------- | ---------------------------------------------------------------- |
| ----------- | ---------------------------------------------------------------- |
| `SPC h SPC` | discover SpaceVim documentation, layers and packages using unite |
| `SPC h i` | get help with the symbol at point |
| `SPC h k` | show top-level bindings with which-key |
@ -784,9 +781,9 @@ Denite/Unite is powerful tool to unite all interfaces. it was meant to be like
Reporting an issue:
| Mappings | Description |
| -------- | ----------------------------------------------------------- |
| `SPC h I`| Open SpaceVim GitHub issue page with pre-filled information |
| Mappings | Description |
| --------- | ----------------------------------------------------------- |
| `SPC h I` | Open SpaceVim GitHub issue page with pre-filled information |
#### Available layers
@ -796,7 +793,17 @@ All layers can be easily discovered via `:SPLayer -l` accessible with `SPC h l`.
All plugins can be easily discovered via `<leader> l p`.
**New packages from ELPA repositories**
**Add custom plugins**
If you want to add plugin from github, just add the repo name to the SpaceVim option `custom_plugins`:
```toml
# custom plugins {{{
[[custom_plugins]]
name = 'lilydjwg/colorizer'
merged = 0
# }}}
```
#### Toggles
@ -1032,12 +1039,14 @@ Convenient key bindings are located under the prefix `SPC f v` to quickly naviga
SpaceVim use vimfiler as the default file tree, and the default key binding is `F3`, and SpaceVim also provide `SPC f t` and `SPC f T` to open the file tree. to change the file explore to nerdtree:
```vim
" the default value is vimfiler
let g:spacevim_filemanager = 'nerdtree'
```toml
# the default value is vimfiler
filemanager = "nerdtree"
```
VCS integration is supported, there will be a column status, this feature maybe make vimfiler slow, so it is not enabled by default. to enable this feature, add `let g:spacevim_enable_vimfiler_gitstatus = 1` to your custom config. here is any picture for this feature:
VCS integration is supported, there will be a column status, this feature maybe make vimfiler slow, so
it is not enabled by default. to enable this feature, add `enable_vimfiler_gitstatus = true` to your custom config.
here is any picture for this feature:
![file-tree](https://user-images.githubusercontent.com/13142418/26881817-279225b2-4bcb-11e7-8872-7e4bd3d1c84e.png)
@ -1183,8 +1192,6 @@ after pressing prefix `z` in normal mode, if you do not remember the mappings, y
| `zz` | smart scroll |
| `z<Left>` | scroll screen N characters to right |
### Auto-saving
### Searching
#### With an external tool

2
docs/quick-start-guide.md
View File

@ -1,6 +1,6 @@
---
title: "Quick start guide"
description: "SpaceVim is a community-driven vim distribution that seeks to provide layer feature."
description: "A quick start guide which will tell you how to install and config SpaceVim, also provides a list of resources for learning SpaceVim."
---
# Quick start guide

2
docs/roadmap.md
View File

@ -21,7 +21,7 @@ There are release milestones and meta milestones ("buckets").
- [todo](https://github.com/SpaceVim/SpaceVim/milestone/4) is a bucket for triaged tickets which should be on the roadmap but cannot yet be assigned to a concrete milestone.
- [unplanned](https://github.com/SpaceVim/SpaceVim/milestone/5) is a bucket for low-priority items or items lacking a feasible path to completion.
## Completed
<!-- call SpaceVim#dev#roadmap#updateCompletedItems() -->
<!-- SpaceVim roadmap completed items start -->