SpaceVim official Chinese document, welcome to try, part of the document is still in translation

Main page: spacevim.org

Github address: github.com/SpaceVim/Sp…

SpaceVim is a community-driven collection of modular VIM/Neovim configurations that contain multiple functional modules and have been optimized for Neovim. Spacevim has a variety of functional modules to choose from, and by selecting specific modules for each language, you can configure an environment suitable for that particular language.

You can submit an issue on Github if you encounter problems or have functional requirements, which will be easier to focus on and fix. We also welcome users who like Vim/ Neovim to join our QQ group to discuss viM-related skills. Click to join our Vim/SpaceVim group.

Here’s a roundup of developments in recent weeks:

Donations SpaceVim

WeChat	Alipay

The following is SpaceVim Chinese manual, part of which has not been translated yet. In order to facilitate you to query relevant information, it has been published on the official website in advance, and will be gradually updated later. Thank you for your support all the time!

• The installation
• update
• The document
  • core idea
    • Memory AIDS
    • Visual interaction
    • consistency
    • community-driven
  • Significant features
  • Shortcut navigation
  • Run a screenshot
    • The welcome page
    • Working interface
  • Who will benefit from SpaceVim?
  • Update and rollback
    • SpaceVim updates itself
      • Automatic updates
      • Update through plug-in Manager
      • Update via Git
    • Update the plugin
  • Configuration module
  • User configuration
    • Automatically generate user configurations
    • User Configuration directory
  • concept
    • Temporary shortcut key
  • Elegant interface
    • The theme
    • The font
    • Interface element switching
    • Status bar & TAB bar
      • The status bar
      • TAB bar
  • manual
    • Automatic completion
      • Unite/Denite
      • Shortcut keys in Unite/Denite buffer
    • interaction
      • shortcuts
        • Shortcut navigation
        • Browse shortcuts via Unite/Denite
      • Get help information
      • The available modules
        • Available plug-ins
        • Add a user-defined plug-in
      • Interface element display switch
    • Normal operation
      • The cursor
      • Quick jump
        • Quick skip to url (TODO)
      • A commonly used pair of shortcut keys
      • Jump, merge, split
        • jump
        • Merge, break up
      • The Windows operating
        • Common shortcut keys for window operation
      • File and Buffer operations
        • Shortcut keys for Buffer operations
        • Creating a blank buffer
        • Special buffer
        • File operation related shortcut keys
        • Vim and SpaceVim related files
      • The file tree
        • Common operations in a file tree
        • Open a file in the file tree
  • Commands starting with g
  • Commands starting with z
  • Auto-saving
  • Searching
    • With an external tool
      • Useful key bindings
      • Searching in current file
      • Searching in all loaded buffers
      • Searching in an arbitrary directory
      • Searching in a project
      • Background searching in a project
      • Searching the web
    • Searching on the fly
    • Persistent highlighting
  • Editing
    • Paste text
      • Auto-indent pasted text
    • Text manipulation commands
    • Text insertion commands
    • Commenting
    • Multi-Encodings
  • Errors handling
  • Managing projects
• Achievements
  • issues
  • Stars, forks and watchers
• Features
  • Awesome ui
  • Mnemonic key bindings
• Language specific mode
• Key Mapping
  • c/c++ support
  • go support
  • python support
• Neovim centric – Dark powered mode of SpaceVim.
• Modular configuration
• Multiple leader mode
  • Global origin vim leader
  • Local origin vim leader
  • Windows function leader
  • Unite work flow leader
• Unite centric work-flow
  • Plugin Highlights
  • Non Lazy-Loaded Plugins
  • Lazy-Loaded Plugins
    • Language
      • Commands
      • Commands
      • Completion
      • Unite
      • Operators & Text Objects
    • Custom Key bindings
      • File Operations
      • Editor UI
      • Window Management
      • Native functions
      • Plugin: Unite
      • Plugin: neocomplete
      • Plugin: NERD Commenter
      • Plugin: Goyo and Limelight
      • Plugin: ChooseWin
      • Plugin: Bookmarks
      • Plugin: Gina/Gita
      • Plugin: vim-signify
      • Misc Plugins
  • Modular configuration
  • Denite/Unite based platform
  • Automatic completion
  • Meticulous tags management
• fast
  • SpaceVim options
  • read
    • Vim 8 New special new journey

The installation

Installing SpaceVim on Linux or Mac is as simple as executing the following command:

curl -sLf https://spacevim.org/install.sh | bashCopy the code

For more custom installation methods, see:

curl -sLf https://spacevim.org/install.sh | bash -s -- -hCopy the code

SpaceVim is a modular configuration that can run on vim or Neovim. For vim and Neovim installation, please refer to the following links:

Install neovim

git clone https://github.com/SpaceVim/SpaceVim.git vimfiles
Copy the code

git clone https://github.com/SpaceVim/SpaceVim.git AppData\Local\nvim
Copy the code

update

Spacevim and the included plug-ins can be updated with the :SPUpdate command, if the specified plug-ins need to be updated, such as: Vim :SPUpdate startuptime.vim or :SPUpdate SpaceVim to update SpaceVim

The document

core idea

Four core ideas: memory assistance, visual interaction, consistency, community driven.

If the above four core ideas are violated, we will try to fix them.

Memory AIDS

Visual interaction

Innovative real-time keyboard shortcut assist system, and query system, easy to quickly query available modules, plug-ins and more information.

consistency

community-driven

Community driven to ensure the speed of bug fixes and new feature updates.

Significant features

Shortcut navigation

SpaceVim doesn’t need to memorize any of the keyboard shortcuts, and has a powerful shortcut navigation system to remind you what each key does. For example, when you press the space bar in Normal mode, you will be prompted as follows:

Run a screenshot

The welcome page

Working interface

Who will benefit from SpaceVim?

• Beginner Vim user.
• Vim users looking for an elegant interface
• Vim users seeking less muscle damage
• Vim users who want to learn a different way to edit files
• Vim users looking for a simple but highly configurable system

Update and rollback

SpaceVim updates itself

SpaceVim’s core files can be updated in a number of ways. It is recommended to update all plug-ins before updating SpaceVim. The details are as follows:

Automatic updates

Update through plug-in Manager

Using the :SPUpdate SpaceVim command will open SpaceVim’s plug-in manager and update SpaceVim, with the progress shown in the plug-in manager buffer.

Update via Git

Update the plugin

Using the :SPUpdate command will update all plug-ins, including SpaceVim itself. Of course, this command also supports parameters. The parameter is the plug-in name. You can add multiple plug-in names as parameters and use the Tab key to complete the plug-in name.

Configuration module

User configuration

The user configuration is saved in the ~/.spacevim.d/folder.

Automatically generate user configurations

User Configuration directory

~/.spacevim. d/ will be added to Vim’s runtimepath &runtimepath. For details, read: H RTP.

Of course, you can also hold the user configuration directory with the environment variable SPACEVIMDIR. Of course, you can also change directory location through soft connection to configure backup.

SpaceVim also supports project local configuration, setting the birth file as.spacevim. d/init.vim in the current directory. Spacevim. d/ in the current directory will also be added to the Vim runtime path.

Here is an example of a user profile:

" Here are some basic customizations, please refer to the ~/.SpaceVim.d/init.vim
" file for all possible options:
let g:spacevim_default_indent = 3
let g:spacevim_max_column     = 80

" Change the default directory where all miscellaneous persistent files go.
" By default it is ~/.cache/vimfiles.
let g:spacevim_plugin_bundle_dir = '~/.cache/vimfiles'

" set SpaceVim colorscheme
let g:spacevim_colorscheme = 'jellybeans'

" Set plugin manager, you want to use, default is dein.vim
let g:spacevim_plugin_manager = 'dein'  " neobundle or dein or vim-plug

" use space as `<Leader>`
let mapleader = "\<space>"

" Set windows shortcut leader [Window], default is `s`
let g:spacevim_windows_leader = 's'

" Set unite work flow shortcut leader [Unite], default is `f`
let g:spacevim_unite_leader = 'f'

" By default, language specific plugins are not loaded. This can be changed
" with the following, then the plugins for go development will be loaded.
call SpaceVim#layers#load('lang#go')

" loaded ui layer
call SpaceVim#layers#load('ui')

" If there is a particular plugin you don't like, you can define this
" variable to disable them entirely:
let g:spacevim_disabled_plugins=[
\ ['junegunn/fzf.vim'].\ ]

" If you want to add some custom plugins, use these options:
let g:spacevim_custom_plugins = [
\ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}].\ ['wsdjeg/GitHub.vim'].\ ]

" set the guifont
let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'Copy the code

More detailed SpaceVim options are available :h SpaceVim.

concept

Temporary shortcut key

SpaceVim defines many temporary shortcuts as needed, which will avoid pressing the SPC front key too much when something needs to be repeated. When temporary shortcut keys are enabled, a shortcut window will open at the bottom of the window, indicating the functions of each temporary shortcut key. Some additional ancillary information will also be available.

Text move temporary shortcut:

Elegant interface

SpaceVim integrates various user interface plug-ins, such as the common file tree, syntax tree, etc., and the default color theme is Gruvbox.

The theme

SpaceVim’s default color theme is Gruvbox. This theme comes in both dark and light colors. Some detailed configurations on this topic can be read :h Gruvbox.

If you need to change the theme of SpaceVim, you can change g:g:spacevim_colorscheme in ~/.spacevim.d /init.vim. For example, use vim-one with Dark Colorscheme

let g:spacevim_colorscheme = 'one'
let g:spacevim_colorscheme_bg = 'dark'Copy the code

You can view all the topics supported by SpaceVim in the topics module.

Note:

SpaceVim uses true colors in terminal by default, so you need to confirm whether your terminal supports true colors before using it. You can read Colours in terminal to know more information about true colors.

The font

let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'Copy the code

Interface element switching

Most interface elements can be hidden or shown by keyboard shortcuts (this group begins with t and T) :

Status bar & TAB bar

The status bar

The core#statusline module, which provides a highly customized status bar with the following features, is inspired by spacemacs’ status bar.

• Display window serial number
• Display the current mode in different colors
• Show serial numbers of search results
• Show/hide syntax check information
• Display or hide battery information
• Show/hide SpaceVim enabled status

Default theme gruvbox status bar color and mode comparison table:

The colors for each of the above modes depend on the theme mode.

Some status bar elements can be switched dynamically:

Powerline font installation:

SpaceVim uses DejaVu Sans Mono for Powerline by default, which you’ll need to install in order for the status bar to display properly. If you want to display other types of separators in the status bar, you need to install Powerline Extra Symbols.

Syntax check information:

Syntax check information element in the status bar If enabled, the current number of syntax errors and warnings is displayed in the status bar when the syntax check is complete.

TODO： add a picture

Syntax check information

Search result information:

When using/or? When searching, or when n or N is pressed, the serial number of the search results will be displayed in the status bar, similar to 20/22 showing the total number of search results and the serial number of the current results. Specific renderings are as follows:

search index in statusline

Battery status information:

Acpi displays the percentage of battery remaining.

Use different colors to display different battery states:

Battery status	color
75% – 100%.	green
30% – 75%.	yellow
0-30%	red

All colors depend on different themes.

Status bar separator:

You can customize the status bar separator by using G :spacevim_statusline_separator, for example using the very common direction arrow as the status bar separator:

let g:spacevim_statusline_separator = 'arrow'Copy the code

The segmentation supported by SpaceVim and screenshots are as follows:

separator	screenshots
arrow
curve
slant
nil
fire

SpaceVim function module:

Function modules can be displayed or hidden by SPC T M shortcut keys. Unicode characters are used by default, and ASCII characters can be enabled by setting let g:spacevim_statusline_unicode_symbols = 0. (Perhaps you can use this option when a proper font cannot be set on the terminal.)

Whether to display the characters in the function module in the status bar is the same as the following shortcut keys:

shortcuts	Unicode	ASCII	function
SPC t 8	today	8	Highlight the information after 80 columns
SPC t f	ⓕ	f	Highlight column 80
SPC t s	ⓢ	s	Syntax checking
SPC t S	Ⓢ	S	Spell check
SPC t w	ⓦ	w	Line end space check

TAB bar

If there is only one Tab, Buffers will be listed in a Tab bar, each containing the serial number, file type icon, and file name. If there is more than one Tab, all tabs are listed in the Tab bar. Each Tab or Baffer on the Tab bar can be quickly accessed by using the shortcut key

number. The default

is \.

manual

Automatic completion

Unite/Denite

Shortcut keys in Unite/Denite buffer

interaction

shortcuts

Shortcut navigation

call SpaceVim#custom#SPC('nnoremap'['f'.'t'].'echom "hello world"'.'test custom SPC'.1)Copy the code

Browse shortcuts via Unite/Denite

Can be through SPC? Use Unite to list the current shortcuts. Unite can then blur the match and display the result by typing a keyboard shortcut letter or description.

Get help information

Denite/Unite is a powerful information filtering browser, similar to Helm in Emacs. These shortcuts will help you quickly get the information you need:

Report a problem:

The available modules

Available plug-ins

You can list all installed plug-ins through the shortcut key

L p, support fuzzy search, press enter will use the browser to open the official website of the plug-in.

Add a user-defined plug-in

let g:spacevim_custom_plugins = [
    \ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}].\ ['wsdjeg/GitHub.vim'].\ ]Copy the code

Interface element display switch

All interface elements switch shortcuts start with [SPC] t or [SPC] t. You can view all shortcuts in the shortcut navigation.

Normal operation

The cursor

The cursor movement defaults to the default form of VI: HJKL.

Quick jump

Quick skip to url (TODO)

Similar to the f key in Firefox’s Vimperator.

A commonly used pair of shortcut keys

Jump, merge, split

Shortcuts prefixed with SPC J are mainly used for jumping, joining, and splitting.

jump

Merge, break up

The Windows operating

Common shortcut keys for window operation

Each window, there is a number, the number is displayed in the status bar at the front, through the SPC number for quick window jump.

Shortcut keys related to window operation (prefixed with SPC W) :

File and Buffer operations

Shortcut keys for Buffer operations

Buffer shortcuts are prefixed with SPC B:

Creating a blank buffer

Special buffer

In SpaceVim, there are many special buffers that are created by plug-ins or SpaceVim itself and are not listed.

File operation related shortcut keys

Vim and SpaceVim related files

SpaceVim related shortcuts are prefixed with SPC F V, which facilitates quick access to SpaceVim configuration files:

The file tree

" the default value is vimfiler
let g:spacevim_filemanager = 'nerdtree'Copy the code

Common operations in a file tree

HJKL is the core of the file tree, which is similar to the shortcut keys commonly used in VIFM:

Open a file in the file tree

Commands starting with g

after pressing prefix g in normal mode, if you do not remember the mappings, you will see the guide which will tell you the functional of all mappings starting with g.

Commands starting with z

Auto-saving

Searching

With an external tool

SpaceVim can be interfaced with different searching tools like:

• rg – ripgrep
• ag – the silver searcher
• pt – the platinum searcher
• ack
• grep

Useful key bindings

Searching in current file

Searching in all loaded buffers

Searching in an arbitrary directory

Searching in a project

Hint: It is also possible to search in a project without needing to open a file beforehand. To do so use SPC p p and then C-s on a given project to directly search into it like with SPC s p. (TODO)

Background searching in a project

Searching the web

Note: to enable google suggestions in vim, you need to add let g:spacevim_enable_googlesuggest = 1 to your custom Configuration file.

Searching on the fly

Persistent highlighting

SpaceVim uses g:spacevim_search_highlight_persist to keep the searched expression highlighted until the next search. It is also possible to clear the highlighting by pressing SPC s c or executing the ex command :noh.

Editing

Paste text

Auto-indent pasted text

Text manipulation commands

Text related commands (start with x):

Text insertion commands

Commenting

Comments are handled by nerdcommenter, it’s bound to the following keys.

Multi-Encodings

SpaceVim use utf-8 as default encoding. there are four options for these case:

• fileencodings (fencs): ucs-bom,utf-8,default,latin1
• fileencoding (fenc): utf-8
• encoding (enc): utf-8
• termencoding (tenc): utf-8 (only supported in vim)

to fix messy display: SPC e a is the mapping for auto detect the file encoding. after detecting file encoding, you can run the command below to fix the encoding:

set enc=utf-8
writeCopy the code

Errors handling

Managing projects

Projects in SpaceVim are managed by vim-projectionist and vim-rooter, vim-rooter will find the root of the project when a .git directory or a .projections.json file is encountered in the file tree.

project manager commands start with p:

Achievements

issues

Stars, forks and watchers

Features

Awesome ui

Mnemonic key bindings

Key Bindings are organized using mnemonic prefixes like B for buffer, P for project, S for search, H for help, etc…

SPC mapping root : SPC means <Space> on the keyboard.

Language specific mode

Key Mapping

Embed. Coggle. It/diagram/WMl…

c/c++ support

1. code completion: autocompletion and fuzzy match.
2. syntax check: Asynchronous linting and make framework.

go support

1. code completion:
2. syntax check:

python support

1. code completion:
2. syntax check:

Neovim centric – Dark powered mode of SpaceVim.

By default, SpaceVim use these dark powered plugins:

1. deoplete.nvim – Dark powered asynchronous completion framework for neovim
2. dein.vim – Dark powered Vim/Neovim plugin manager

Modular configuration

Multiple leader mode

Global origin vim leader

Vim’s origin global leader can be used in all modes.

Local origin vim leader

Windows function leader

Windows function leader can only be used in normal mode. For the list of mappings see the link

Unite work flow leader

Unite work flow leader can only be used in normal mode. Unite leader need unite groups.

Unite centric work-flow

Plugin Highlights

• Package management with caching enabled and lazy loading

• Project-aware tabs and label

• Vimfiler as file-manager + SSH connections

• Go completion via vim-go and gocode

• Javascript completion via Tern

• PHP completion, indent, folds, syntax

• Python jedi completion, pep8 convention

• Languages: Ansible, css3, csv, json, less, markdown, mustache

• Helpers: Undo tree, bookmarks, git, tmux navigation, hex editor, sessions, and much more.

  Note that 90% of the plugins are [lazy-loaded].

  [lazy-loaded]: ./config/plugins.vim

Non Lazy-Loaded Plugins

Lazy-Loaded Plugins

Language

Commands

Commands

Completion

Unite

Operators & Text Objects

Custom Key bindings

File Operations

Editor UI

Window Management

Native functions

Plugin: Unite

Plugin: neocomplete

Plugin: NERD Commenter

Plugin: Goyo and Limelight

Plugin: ChooseWin

Plugin: Bookmarks

As SpaceVim use above bookmarks mappings, so you can not use a, m, n, p or i registers to mark current position, but other registers should works will. if you really need to use these registers, you can add nnoremap <leader>m m to your custom configuration, then you use use a registers via \ma

Plugin: Gina/Gita

Plugin: vim-signify

Misc Plugins

Modular configuration

SpaceVim is a configuration set composed of multiple independent modules designed for different functional requirements, and users only need to load the corresponding modules when using them. For Java developers, load lang# Java, autocomplete, checker, tags modules to configure a Vim environment suitable for Java development.

Modules supported by SpaceVim: spacevim.org/layers/

Denite/Unite based platform

Automatic completion

SpaceVim uses deoplete, the fastest completion engine, which differs from YouCompleteMe in that it supports multi-source completion, not just semantic completion. And complete the source expansion is very convenient.

Meticulous tags management

fast

SpaceVim will load the configuration from ~/.spacevim.d /init.vim and the./ spacevim.d /init.vim of the current directory, and update the RTP, Users can edit their own scripts and SpaceVim configuration files in the ~/.spacevim.d/and.spacevim.d/folders.

Example:

" Here are some basic customizations,
" please refer to the ~/.SpaceVim.d/init.vim
" file for all possible options:
let g:spacevim_default_indent = 3
let g:spacevim_max_column     = 80

" Change the default directory where all miscellaneous persistent files go.
" By default it is ~/.cache/vimfiles/.
let g:spacevim_plugin_bundle_dir = '~/.cache/vimfiles/'

" set SpaceVim colorscheme
let g:spacevim_colorscheme = 'jellybeans'

" Set plugin manager, you want to use, default is dein.vim
let g:spacevim_plugin_manager = 'dein'  " neobundle or dein or vim-plug

" use space as `<Leader>`
let mapleader = "\<space>"

" Set windows shortcut leader [Window], default is `s`
let g:spacevim_windows_leader = 's'

" Set unite work flow shortcut leader [Unite], default is `f`
let g:spacevim_unite_leader = 'f'

" By default, language specific plugins are not loaded. This can be changed
" with the following, then the plugins for go development will be loaded.
call SpaceVim#layers#load('lang#go')

" loaded ui layer
call SpaceVim#layers#load('ui')

" If there is a particular plugin you don't like, you can define this
" variable to disable them entirely:
let g:spacevim_disabled_plugins=[
    \ ['junegunn/fzf.vim'].\ ]

" If you want to add some custom plugins, use these options:
let g:spacevim_custom_plugins = [
    \ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}].\ ['wsdjeg/GitHub.vim'].\ ]

" set the guifont
let g:spacevim_guifont = 'DejaVu\ Sans\ Mono\ for\ Powerline\ 11'Copy the code

SpaceVim options

read

Vim 8 New special new journey