2017-02-21 22:38:19 +08:00
< p align = "center" > < img src = "https://spacevim.org/logo.png" alt = "SpaceVim" / > < / p >
2017-01-10 00:27:52 +08:00
2017-01-08 13:50:17 +08:00
[](https://travis-ci.org/SpaceVim/SpaceVim)
2017-01-09 13:35:05 +08:00
[](LICENSE)
2017-01-08 13:50:17 +08:00
[](doc/SpaceVim.txt)
2017-02-05 10:03:28 +08:00
2017-01-19 22:08:40 +08:00
2017-02-10 19:43:38 +08:00
### Table of Contents
- [Introduction ](#introduction )
- [Community ](#community )
- [Install ](#install )
- [Linux/Mac ](#linuxmac )
- [Windows support ](#windows-support )
- [File Structure ](#file-structure )
- Features
- [Awesome ui ](#awesome-ui )
- [Language specific mode ](#language-specific-mode )
- [c/c++ support ](#cc-support )
- [python support ](#python-support )
- [go support ](#go-support )
- lua support
2017-02-17 12:56:17 +08:00
- perl support
2017-02-21 21:21:04 +08:00
- [php support ](#php-support )
2017-02-17 12:56:17 +08:00
- rust support
2017-02-10 19:43:38 +08:00
- [Unite centric work-flow ](#unite-centric-work-flow )
- [Neovim centric - Dark powered mode ](#neovim-centric---dark-powered-mode-of-spacevim )
- [multiple leader mode ](#multiple-leader-mode )
- [Modular configuration ](#modular-configuration )
- Lazy-load 90% of plugins with [dein.vim]
- Robust, yet light weight
- Extensive Neocomplete setup
- Central location for tags
- Lightweight simple status/tabline
- Premium color-schemes
- [Custom configuration ](#custom-configuration )
- [Support SpaceVim ](#support-spacevim )
- [Report bugs ](#report-bugs )
- [contribute to SpaceVim ](#contribute-to-spacevim )
- Write post about SpaceVim
- [Credits & Thanks ](#credits--thanks )
2017-01-28 23:03:40 +08:00
#### Introduction
2017-02-05 09:55:10 +08:00
2017-01-14 13:12:49 +08:00
[SpaceVim ](https://github.com/SpaceVim/SpaceVim ) is a Modular configuration, a bundle of custom settings and plugins for Vim,
2017-01-30 00:56:37 +08:00
here we call them layers, each layer has different plugins and config, users just need
2017-01-14 13:06:18 +08:00
to select the layers they need. It got inspired by [spacemacs ](https://github.com/syl20bnr/spacemacs ). If you use SpaceVim,
please star it on github. It's a great way of getting feedback and gives me the kick to
put more time into development.
2017-01-04 21:04:42 +08:00
2017-01-14 13:06:18 +08:00
If you encounter any bugs or have feature requests, just open an issue
report on Github.
For learning about Vim in general, read [vim-galore ](https://github.com/mhinz/vim-galore ).
2016-12-26 23:59:21 +08:00
2017-01-11 17:23:53 +08:00
[](https://waffle.io/SpaceVim/SpaceVim/metrics/throughput)
2017-01-02 18:19:34 +08:00
2017-02-10 19:43:38 +08:00
#### Community
Try these Neovim hangouts for any questions, problems or comments.
- Ask
- [issue tracker ](https://github.com/SpaceVim/SpaceVim/issues ) for issue and feature requests
- vi StackExchange for "how to" & configuration questions
- [](https://twitter.com/SpaceVim) for hugs & pithy comments
- Chat
- [](https://gitter.im/SpaceVim/SpaceVim?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
- [](https://jq.qq.com/?_wv=1027& k=43DB6SG)
- [](https://www.facebook.com/SpaceVim)
- Discuss
2017-01-08 21:27:43 +08:00
#### Install
2017-01-04 00:20:25 +08:00
2017-01-28 23:11:29 +08:00
##### Linux/Mac
2017-01-28 19:54:50 +08:00
2017-01-04 00:20:25 +08:00
```sh
2017-01-07 12:17:46 +08:00
curl -sLf https://spacevim.org/install.sh | bash
2017-01-04 00:20:25 +08:00
```
2017-01-04 20:42:05 +08:00
before use SpaceVim, you should install the plugin by `call dein#install()`
2017-01-30 00:56:37 +08:00
Installation of neovim/vim with python support:
2017-01-11 17:23:53 +08:00
> [neovim installation](https://github.com/neovim/neovim/wiki/Installing-Neovim)
2017-01-04 20:44:05 +08:00
> [Building Vim from source](https://github.com/Valloric/YouCompleteMe/wiki/Building-Vim-from-source)
2017-01-04 00:20:25 +08:00
2017-01-07 00:43:13 +08:00
for more info about the install script, please check:
```sh
2017-01-07 12:17:46 +08:00
curl -sLf https://spacevim.org/install.sh | bash -s -- -h
2017-01-07 00:43:13 +08:00
```
2017-01-08 21:27:43 +08:00
##### windows support
2017-01-08 21:30:02 +08:00
- For vim in windows, please just clone this repo as vimfiles in you Home directory.
2017-01-30 17:37:52 +08:00
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
2017-02-10 20:37:31 +08:00
make sure you have a backup of your own vimfiles. also you need remove `~/_vimrc` in your home directory.
2017-01-08 21:27:43 +08:00
2017-01-22 23:52:09 +08:00
```sh
git clone https://github.com/SpaceVim/SpaceVim.git vimfiles
```
2017-01-08 21:27:43 +08:00
- For neovim in windows, please clone this repo as `AppData\Local\nvim` in your home directory.
2017-01-10 18:51:21 +08:00
for more info, please check out [neovim's wiki ](https://github.com/neovim/neovim/wiki/Installing-Neovim ).
2017-01-30 17:37:52 +08:00
by default, when open a cmd, the current dir is your Home directory, run this command in cmd.
2017-01-08 21:27:43 +08:00
2017-01-22 23:52:09 +08:00
```sh
git clone https://github.com/SpaceVim/SpaceVim.git AppData\Local\nvim
```
2017-01-08 21:27:43 +08:00
2017-02-10 19:43:38 +08:00
#### File Structure
2017-02-21 23:18:52 +08:00
- [autoload/ ](./autoload )
- [SpaceVim.vim ](./autoload/SpaceVim.vim ) - SpaceVim options init
- [SpaceVim/layers ](./autoload/SpaceVim/layers ) - SpaceVim layers
- [SpaceVim/api ](./autoload/SpaceVim/api ) - SpaceVim apis
- [SpaceVim/default.vim ](./autoload/SpaceVim/default.vim ) - SpaceVim default status
2017-02-10 19:43:38 +08:00
- [config ](./config )/ - Configuration
- [general.vim ](./config/general.vim ) - General configuration
- [init.vim ](./config/init.vim ) - `runtimepath` initialization
- [neovim.vim ](./config/neovim.vim ) - Neovim specific setup
- [commands.vim ](./config/commands.vim ) - Commands
- [functions.vim ](./config/functions.vim ) - Functions
- [main.vim ](./config/main.vim ) - Main config
- [ftplugin ](./ftplugin )/ - Language specific custom settings
2017-02-21 23:16:39 +08:00
- [snippets ](./snippets )/ - Code snippets
2017-02-10 19:43:38 +08:00
- [filetype.vim ](./filetype.vim ) - Custom filetype detection
- [init.vim ](./init.vim ) - Sources `config/main.vim`
- [vimrc ](./vimrc ) - Sources `config/main.vim`
#### Features
##### Awesome ui
- outline + filemanager + checker
##### Language specific mode
###### 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:
2017-02-21 21:21:04 +08:00
###### php support
1. code completion:
[](https://asciinema.org/a/4dzyyjymrguylqt21igxlhhqx)
2017-02-10 19:43:38 +08:00
##### Neovim centric - Dark powered mode of SpaceVim.
By default, SpaceVim use these dark powered plugins:
1. [deoplete.nvim ](https://github.com/Shougo/deoplete.nvim ) - Dark powered asynchronous completion framework for neovim
2. [dein.vim ](https://github.com/Shougo/dein.vim ) - Dark powered Vim/Neovim plugin manager
TODO:
1. [defx.nvim ](https://github.com/Shougo/defx.nvim ) - Dark powered file explorer
2. [deoppet.nvim ](https://github.com/Shougo/deoppet.nvim ) - Dark powered snippet plugin
3. [denite.nvim ](https://github.com/Shougo/denite.nvim ) - Dark powered asynchronous unite all interfaces for Neovim/Vim8
##### Modular configuration
- SpaceVim will load custom configuration from `~/.local.vim` and `.local.vim` in current directory.
- SpaceVim support `~/.SpaceVim.d/init.vim` and `./SpaceVim.d/init.vim` .
Here is an example:
```viml
" Here are some basic customizations, please refer to the top of the vimrc
" file for all possible options:
let g:spacevim_default_indent = 3
let g:spacevim_max_column = 80
let g:spacevim_colorscheme = 'my_awesome_colorscheme'
let g:spacevim_plugin_manager = 'dein' " neobundle or dein or vim-plug
" Change the default directory where all miscellaneous persistent files go.
" By default it is ~/.cache/vimfiles.
let g:spacevim_plugin_bundle_dir = "/some/place/else"
" By default, language specific plugins are not loaded. This can be changed
" with the following:
let g:spacevim_plugin_groups_exclude = ['ruby', 'python']
" If there are groups you want always loaded, you can use this:
let g:spacevim_plugin_groups_include = ['go']
" Alternatively, you can set this variable to load exactly what you want:
let g:spacevim_plugin_groups = ['core', 'web']
" If there is a particular plugin you don't like, you can define this
" variable to disable them entirely:
let g:spacevim_disabled_plugins=['vim-foo', 'vim-bar']
" 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'],
\ ]
" Anything defined here are simply overrides
set wildignore+=\*/node_modules/\*
set guifont=Wingdings:h10
```
#### Multiple leader mode
##### Global origin vim leader, default : `\`
Vim's origin global leader can be used in all modes.
##### Local origin vim leader, default : `,`
Vim's origin local leader can be used in all the mode.
##### Windows function leader, default : `s`
Windows function leader can only be used in normal mode.
For the list of mappings see the [link ](#window-management )
##### Unite work flow leader, default : `f`
Unite work flow leader can only be used in normal mode. Unite leader need unite groups.
#### Unite centric work-flow
- List all the plugins has been installed, fuzzy find what you want, default action is open the github website of current plugin. default key is `<leader>lp`
- List all the mappings and description: `f<space>`
- List all the starred repos in github.com, fuzzy find and open the website of the repo. default key is `<leader>ls`
#### 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
Name | Description
-------------- | ----------------------
[dein.vim] | Dark powered Vim/Neovim plugin manager
[vimproc] | Interactive command execution
[colorschemes] | Awesome color-schemes
[file-line] | Allow opening a file in a given line
[neomru] | MRU source for Unite
[cursorword] | Underlines word under cursor
[gitbranch] | Lightweight git branch detection
[gitgutter] | Shows git diffs in the gutter
[tinyline] | Tiny great looking statusline
[tagabana] | Central location for all tags
[bookmarks] | Bookmarks, works independently from vim marks
[tmux-navigator] | Seamless navigation between tmux panes and vim splits
#### Lazy-Loaded Plugins
##### Language
Name | Description
-------------- | ----------------------
[html5] | HTML5 omnicomplete and syntax
[mustache] | Mustache and handlebars syntax
[markdown] | Markdown syntax highlighting
[ansible-yaml] | Additional support for Ansible
[jinja] | Jinja support in vim
[less] | Syntax for LESS
[css3-syntax] | CSS3 syntax support to vim's built-in `syntax/css.vim`
[csv] | Handling column separated data
[pep8-indent] | Nicer Python indentation
[logstash] | Highlights logstash configuration files
[tmux] | vim plugin for tmux.conf
[json] | Better JSON support
[toml] | Syntax for TOML
[i3] | i3 window manager config syntax
[Dockerfile] | syntax and snippets for Dockerfile
[go] | Go development
[jedi-vim] | Python jedi autocompletion library
[ruby] | Ruby configuration files
[portfile] | Macports portfile configuration files
[javascript] | Enhanced Javascript syntax
[javascript-indent] | Javascript indent script
[tern] | Provides Tern-based JavaScript editing support
[php] | Up-to-date PHP syntax file
2017-02-21 21:21:04 +08:00
[phpcd] | PHP Completion Daemon for Vim/NeoVim
2017-02-10 19:43:38 +08:00
[phpfold] | PHP folding
[phpindent] | PHP official indenting
[phpspec] | PhpSpec integration
##### Commands
Name | Description
-------------- | ----------------------
[vimfiler] | Powerful file explorer
2017-02-11 16:11:34 +08:00
[nerdcommenter] | Comment tool - no comment necessary
2017-02-10 19:43:38 +08:00
[vinarise] | Hex editor
[syntastic] | Syntax checking hacks
[gita] | An awesome git handling plugin
[gista] | Manipulate gists in Vim
[undotree] | Ultimate undo history visualizer
[incsearch] | Improved incremental searching
[expand-region] | Visually select increasingly larger regions of text
[open-browser] | Open URI with your favorite browser
[prettyprint] | Pretty-print vim variables
[quickrun] | Run commands quickly
[ref] | Integrated reference viewer
[dictionary] | Dictionary.app interface
[vimwiki] | Personal Wiki for Vim
[thesaurus] | Look up words in an online thesaurus
##### Commands
Name | Description
-------------- | ----------------------
[goyo] | Distraction-free writing
[limelight] | Hyperfocus-writing
[matchit] | Intelligent pair matching
[indentline] | Display vertical indention lines
[choosewin] | Choose window to use, like tmux's 'display-pane'
##### Completion
Name | Description
-------------- | ----------------------
[delimitmate] | Insert mode auto-completion for quotes, parenthesis, brackets
[echodoc] | Print objects' documentation in echo area
[deoplete] | Neovim: Dark powered asynchronous completion framework
[neocomplete] | Next generation completion framework
[neosnippet] | Contains neocomplete snippets source
##### Unite
Name | Description
-------------- | ----------------------
[unite] | Unite and create user interfaces
[unite-colorscheme] | Browse colorschemes
[unite-filetype] | Select file type
[unite-history] | Browse history of command/search
[unite-build] | Build with Unite interface
[unite-outline] | File "outline" source for unite
[unite-tag] | Tags source for Unite
[unite-quickfix] | Quickfix source for Unite
[neossh] | SSH interface for plugins
[unite-pull-request] | GitHub pull-request source for Unite
[junkfile] | Create temporary files for memo and testing
[unite-issue] | Issue manager for JIRA and GitHub
##### Operators & Text Objects
Name | Description
-------------- | ----------------------
[operator-user] | Define your own operator easily
[operator-replace] | Operator to replace text with register content
[operator-surround] | Operator to enclose text objects
[textobj-user] | Create your own text objects
[textobj-multiblock] | Handle multiple brackets objects
#### Custom Key bindings
Key | Mode | Action
----- |:----:| ------------------
`<leader>` +`y` | visual | Copy selection to X11 clipboard ("+y)
`Ctrl` +`c` | Normal | Copy full path of current buffer to X11 clipboard
`<leader>` +`Ctrl`+`c` | Normal | Copy github.com url of current buffer to X11 clipboard(if it is a github repo)
`<leader>` +`Ctrl`+`l` | Normal/visual | Copy github.com url of current lines to X11 clipboard(if it is a github repo)
`<leader>` +`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 (}^)
`<` | 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 (< Nop > )
`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
Key | Mode | Action
----- |:----:| ------------------
`<leader>` +`cd` | Normal | Switch to the directory of the open buffer
`<leader>` +`w` | Normal/visual | Write (:w)
`Ctrl` +`s` | Normal/visual/Command | Write (:w)
`:w!!` | Command | Write as root (%!sudo tee > /dev/null %)
##### Editor UI
Key | Mode | Action
----- |:----:| ------------------
`F2` | _All_ | Toggle tagbar
`F3` | _All_ | Toggle Vimfiler
`<leader>` +`ts` | Normal | Toggle spell-checker (:setlocal spell!)
`<leader>` +`tn` | Normal | Toggle line numbers (:setlocal nonumber!)
`<leader>` +`tl` | Normal | Toggle hidden characters (:setlocal nolist!)
`<leader>` +`th` | Normal | Toggle highlighted search (:set hlsearch!)
`<leader>` +`tw` | Normal | Toggle wrap (:setlocal wrap! breakindent!)
`g0` | Normal | Go to first tab (:tabfirst)
`g$` | Normal | Go to last tab (:tablast)
`gr` | Normal | Go to previous tab (:tabprevious)
`Ctrl` +`< Dow > ` | Normal | Move to split below (< C-w > j)
`Ctrl` +`< Up > ` | Normal | Move to upper split (< C-w > k)
`Ctrl` +`< Left > ` | Normal | Move to left split (< C-w > h)
`Ctrl` +`< Right > ` | Normal | Move to right split (< C-w > l)
`*` | Visual | Search selection forwards
`#` | Visual | Search selection backwards
`,` +`Space` | Normal | Remove all spaces at EOL
`Ctrl` +`r` | Visual | Replace selection
`<leader>` +`lj` | Normal | Next on location list
`<leader>` +`lk` | Normal | Previous on location list
`<leader>` +`S` | Normal/visual | Source selection
##### Window Management
2017-02-22 20:07:19 +08:00
default `[Window]` key is `s` , and it is setup by `g:spacevim_windows_leader` .
2017-02-10 19:43:38 +08:00
Key | Mode | Action
----- |:----:| ------------------
2017-02-22 20:07:19 +08:00
`q` | Normal | Smart close current window
`[Window]` +`p` | Normal | Split nicely
`[Window]` +`v` | Normal | :split
`[Window]` +`g` | Normal | :vsplit
`[Window]` +`t` | Normal | Open new tab (:tabnew)
`[Window]` +`o` | Normal | Close other windows (:only)
`[Window]` +`x` | Normal | Remove buffer, leave blank window
`[Window]` +`q` | Normal | Closes current buffer (:close)
`[Widnow]` +`Q` | Normal | Removes current buffer (:bdelete)
`[Window]` +`c` | Normal | Clear up all of other buffers and windows
`Tab` | Normal | Next window or tab (:wincmd w)
`Shift` +`Tab` | Normal | Previous window or tab (:wincmd p)
2017-02-10 19:43:38 +08:00
`<leader>` +`sv` | Normal | Split with previous buffer
`<leader>` +`sg` | Normal | Vertical split with previous buffer
##### Plugin: Unite
Key | Mode | Action
----- |:----:| ------------------
`[unite]` | Normal | unite leader, default is `f` , `:h g:spacevim_unite_leader`
`[unite]` +`r` | Normal | Resumes Unite window
`[unite]` +`f` | Normal | Opens Unite file recursive search
`[unite]` +`i` | Normal | Opens Unite git file search
`[unite]` +`g` | Normal | Opens Unite grep with ag (the_silver_searcher)
`[unite]` +`u` | Normal | Opens Unite source
`[unite]` +`t` | Normal | Opens Unite tag
`[unite]` +`T` | Normal | Opens Unite tag/include
`[unite]` +`l` | Normal | Opens Unite location list
`[unite]` +`q` | Normal | Opens Unite quick fix
`[unite]` +`e` | Normal | Opens Unite register
`[unite]` +`j` | Normal | Opens Unite jump, change
`[unite]` +`h` | Normal | Opens Unite history/yank
`[unite]` +`s` | Normal | Opens Unite session
`[unite]` +`n` | Normal | Opens Unite session/new
`[unite]` +`o` | Normal | Opens Unite outline
`[unite]` +`c` | Normal | Opens Unite buffer bookmark file in current directory
`[unite]` +`b` | Normal | Opens Unite buffer bookmark file in buffer directory
`[unite]` +`ma` | Normal | Opens Unite mapping
`[unite]` +`< space > ` | Normal | Opens Unite menu:CustomKeyMaps
`[unite]` +`me` | Normal | Opens Unite output messages
`<leader>` +`bl` | Normal | Opens Unite buffers, mru, bookmark
`<leader>` +`ta` | Normal | Opens Unite tab
`<leader>` +`ugf` | Normal | Opens Unite file with word at cursor
`<leader>` +`ugt` | Normal/visual | Opens Unite tag with word at cursor
| **Within _Unite_ buffers** |||
`Ctrl` +`h/k/l/r` | Normal | Un-map
`Ctrl` +`r` | Normal | Redraw
`Ctrl` +`j` | Insert | Select next line
`Ctrl` +`k` | Insert | Select previous line
`'` | Normal | Toggle mark current candidate, up
`e` | Normal | Run default action
`Ctrl` +`v` | Normal | Open in a split
`Ctrl` +`s` | Normal | Open in a vertical split
`Ctrl` +`t` | Normal | Open in a new tab
`Tab` | Normal | `Ctrl` +`w`+`w`
`Escape` | Normal | Exit unite
`jj` | Insert | Leave Insert mode
`r` | Normal | Replace ('search' profile) or rename
`Tab` | Insert | Unite autocompletion
`Ctrl` +`z` | Normal/insert | Toggle transpose window
`Ctrl` +`w` | Insert | Delete backward path
##### Plugin: VimFiler
Key | Mode | Action
----- |:----:| ------------------
`<F3>` | Normal | Toggle file explorer
| **Within _VimFiler_ buffers** |||
`Ctrl` +`j` | Normal | Un-map
`Ctrl` +`l` | Normal | Un-map
`E` | Normal | Un-map
`sv` | Normal | Split edit
`sg` | Normal | Vertical split edit
`p` | Normal | Preview
`i` | Normal | Switch to directory history
`v` | Normal | Quick look
`gx` | Normal | Execute with vimfiler associated
`'` | Normal | Toggle mark current line
`V` | Normal | Clear all marks
`Ctrl` +`r` | Normal | Redraw
##### Plugin: neocomplete
Key | Mode | Action
----- |:----:| ------------------
`Enter` | Insert | Smart snippet expansion
`Ctrl` +`space` | Insert | Autocomplete with Unite
`Tab` | Insert/select | Smart tab movement or completion
`Ctrl` +`j/k/f/b` | Insert | Movement in popup
`Ctrl` +`g` | Insert | Undo completion
`Ctrl` +`l` | Insert | Complete common string
`Ctrl` +`o` | Insert | Expand snippet
`Ctrl` +`y` | Insert | Close pop-up
`Ctrl` +`e` | Insert | Close pop-up
`Ctrl` +`l` | Insert | Complete common string
`Ctrl` +`d` | Insert | Scroll down
`Ctrl` +`u` | Insert | Scroll up
##### Plugin: NERD Commenter
Key | Mode | Action
----- |:----:| ------------------
`<leader>` +`cc` | Normal/visual | Comment out the current line or text selected in visual mode.
`<leader>` +`cn` | Normal/visual | Same as cc but forces nesting.
`<leader>` +`cu` | Normal/visual | Uncomments the selected line(s).
`<leader>` +`cs` | Normal/visual | Comments out the selected lines with a pretty block formatted layout.
`<leader>` +`cy` | Normal/visual | Same as cc except that the commented line(s) are yanked first.
##### Plugin: Goyo and Limelight
Key | Mode | Action
----- |:----:| ------------------
`<leader>` +`G` | Normal | Toggle distraction-free writing
##### Plugin: ChooseWin
Key | Mode | Action
----- |:----:| ------------------
`-` | Normal | Choose a window to edit
`<leader>` +`-` | Normal | Switch editing window with selected
##### Plugin: Bookmarks
Key | Mode | Action
----- |:----:| ------------------
`m` +`a` | Normal | Show list of all bookmarks
`m` +`m` | Normal | Toggle bookmark in current line
`m` +`n` | Normal | Jump to next bookmark
`m` +`p` | Normal | Jump to previous bookmark
`m` +`i` | Normal | Annotate bookmark
##### Plugin: Gita
Key | Mode | Action
----- |:----:| ------------------
`<leader>` +`gs` | Normal | Git status
`<leader>` +`gd` | Normal | Git diff
`<leader>` +`gc` | Normal | Git commit
`<leader>` +`gb` | Normal | Git blame
`<leader>` +`gp` | Normal | Git push
##### Plugin: vim-signify
Key | Mode | Action
----- |:----:| ------------------
`<leader>` +`hj` / `]c` | Normal | Jump to next hunk
`<leader>` +`hk` / `[c` | Normal | Jump to previous hunk
`<leader>` +`hJ` / `]C` | Normal | Jump to last hunk
`<leader>` +`hK` / `[C` | Normal | Jump to first hunk
##### Misc Plugins
Key | Mode | Action
----- |:----:| ------------------
`<leader>` +`gu` | Normal | Open undo tree
`<leader>` +`i` | Normal | Toggle indentation lines
`<leader>` +`j` | Normal | Start smalls
`<leader>` +`r` | Normal | Quickrun
`<leader>` +`?` | Normal | Dictionary
`<leader>` +`W` | Normal | Wiki
`<leader>` +`K` | Normal | Thesaurus
#### Custom configuration
SpaceVim use `~/.SpaceVim.d/init.vim` as default global init file. you can set
SpaceVim-options or config layers in it. SpaceVim also will add `~/.SpaceVim.d/`
into runtimepath. so you can write your own vim script in it.
SpaceVim also support local config file for project, the init file is `.SpaceVim.d/init.vim`
in the root of your project. `.SpaceVim.d/` will also be added into runtimepath.
here is an example config file for SpaceVim:
```viml
" set the options of SpaceVim
let g:spacevim_colorscheme = 'solarized'
" setting layers, load 'lang#java' layer.
call SpaceVim#layers#load('lang#java')
" add custom plugins.
let g:spacevim_custom_plugins = [
\ ['plasticboy/vim-markdown', {'on_ft' : 'markdown'}],
\ ['wsdjeg/GitHub.vim'],
\ ]
" custom mappings:
nnoremap < c-l > :Ydc< cr >
```
#### Support SpaceVim
##### report bugs
If you get any issues, please open an issue with the ISSUE_TEMPLATE. It is useful for me to debug for this issue.
##### contribute to SpaceVim
#### Credits & Thanks
- [](https://github.com/SpaceVim/SpaceVim/graphs/contributors)
- [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
<!-- plublic links -->
[dein.vim]: https://github.com/Shougo/dein.vim
[vimproc]: https://github.com/Shougo/vimproc.vim
[colorschemes]: https://github.com/rafi/awesome-vim-colorschemes
[file-line]: https://github.com/bogado/file-line
[neomru]: https://github.com/Shougo/neomru.vim
[cursorword]: https://github.com/itchyny/vim-cursorword
[gitbranch]: https://github.com/itchyny/vim-gitbranch
[gitgutter]: https://github.com/airblade/vim-gitgutter
[bookmarks]: https://github.com/MattesGroeger/vim-bookmarks
[tmux-navigator]: https://github.com/christoomey/vim-tmux-navigator
[tinyline]: https://github.com/rafi/vim-tinyline
[tagabana]: https://github.com/rafi/vim-tagabana
[html5]: https://github.com/othree/html5.vim
[mustache]: https://github.com/mustache/vim-mustache-handlebars
[markdown]: https://github.com/rcmdnk/vim-markdown
[ansible-yaml]: https://github.com/chase/vim-ansible-yaml
[jinja]: https://github.com/mitsuhiko/vim-jinja
[less]: https://github.com/groenewege/vim-less
[css3-syntax]: https://github.com/hail2u/vim-css3-syntax
[csv]: https://github.com/chrisbra/csv.vim
[pep8-indent]: https://github.com/hynek/vim-python-pep8-indent
[logstash]: https://github.com/robbles/logstash.vim
[tmux]: https://github.com/tmux-plugins/vim-tmux
[json]: https://github.com/elzr/vim-json
[toml]: https://github.com/cespare/vim-toml
[i3]: https://github.com/PotatoesMaster/i3-vim-syntax
[Dockerfile]: https://github.com/ekalinin/Dockerfile.vim
[go]: https://github.com/fatih/vim-go
[jedi-vim]: https://github.com/davidhalter/jedi-vim
[ruby]: https://github.com/vim-ruby/vim-ruby
[portfile]: https://github.com/jstrater/mpvim
[javascript]: https://github.com/jelera/vim-javascript-syntax
[javascript-indent]: https://github.com/jiangmiao/simple-javascript-indenter
[tern]: https://github.com/marijnh/tern_for_vim
[php]: https://github.com/StanAngeloff/php.vim
2017-02-21 21:21:04 +08:00
[phpfold]: https://github.com/lvht/phpfold.vim
[phpcd]: https://github.com/lvht/phpcd.vim
2017-02-10 19:43:38 +08:00
[phpindent]: https://github.com/2072/PHP-Indenting-for-VIm
[phpspec]: https://github.com/rafi/vim-phpspec
[vimfiler]: https://github.com/Shougo/vimfiler.vim
[tinycomment]: https://github.com/rafi/vim-tinycomment
[vinarise]: https://github.com/Shougo/vinarise.vim
[syntastic]: https://github.com/scrooloose/syntastic
[gita]: https://github.com/lambdalisue/vim-gita
[gista]: https://github.com/lambdalisue/vim-gista
[undotree]: https://github.com/mbbill/undotree
[incsearch]: https://github.com/haya14busa/incsearch.vim
[expand-region]: https://github.com/terryma/vim-expand-region
[open-browser]: https://github.com/tyru/open-browser.vim
[prettyprint]: https://github.com/thinca/vim-prettyprint
[quickrun]: https://github.com/thinca/vim-quickrun
[ref]: https://github.com/thinca/vim-ref
[dictionary]: https://github.com/itchyny/dictionary.vim
[vimwiki]: https://github.com/vimwiki/vimwiki
[thesaurus]: https://github.com/beloglazov/vim-online-thesaurus
[goyo]: https://github.com/junegunn/goyo.vim
[limelight]: https://github.com/junegunn/limelight.vim
[matchit]: http://www.vim.org/scripts/script.php?script_id=39
[indentline]: https://github.com/Yggdroot/indentLine
[choosewin]: https://github.com/t9md/vim-choosewin
[delimitmate]: https://github.com/Raimondi/delimitMate
[echodoc]: https://github.com/Shougo/echodoc.vim
[deoplete]: https://github.com/Shougo/deoplete.nvim
[neocomplete]: https://github.com/Shougo/neocomplete.vim
[neosnippet]: https://github.com/Shougo/neosnippet.vim
[unite]: https://github.com/Shougo/unite.vim
[unite-colorscheme]: https://github.com/ujihisa/unite-colorscheme
[unite-filetype]: https://github.com/osyo-manga/unite-filetype
[unite-history]: https://github.com/thinca/vim-unite-history
[unite-build]: https://github.com/Shougo/unite-build
[unite-outline]: https://github.com/h1mesuke/unite-outline
[unite-tag]: https://github.com/tsukkee/unite-tag
[unite-quickfix]: https://github.com/osyo-manga/unite-quickfix
[neossh]: https://github.com/Shougo/neossh.vim
[unite-pull-request]: https://github.com/joker1007/unite-pull-request
[junkfile]: https://github.com/Shougo/junkfile.vim
[unite-issue]: https://github.com/rafi/vim-unite-issue
[operator-user]: https://github.com/kana/vim-operator-user
[operator-replace]: https://github.com/kana/vim-operator-replace
[operator-surround]: https://github.com/rhysd/vim-operator-surround
[textobj-user]: https://github.com/kana/vim-textobj-user
[textobj-multiblock]: https://github.com/osyo-manga/vim-textobj-multiblock
