SpaceVim/docs/layers/index.md

---
title:  Available layers
description: "A guide for managing SpaceVim with layers, tell you how to enable and disable a layer, also list all available layers in SpaceVim"
---

# Available layers

<!-- vim-markdown-toc GFM -->

- [Introduction](#introduction)
  - [Enable layers](#enable-layers)
  - [Disable layers](#disable-layers)
- [Available layers](#available-layers)

<!-- vim-markdown-toc -->

## Introduction

SpaceVim is a community-driven vim distribution that seeks to provide layer feature.
Layers help collect related packages together to provide features.
This approach helps keep configuration organized and reduces overhead for the user by
keeping them from having to think about what packages to install.

### Enable layers

By default only `autocomplete`, `checkers` layer are enabled. To enable a specific layer
you need to edit SpaceVim configuration file. The key binding for opening SpaceVim 
configuration file is `SPC f v d`

here is an example for loadding `shell` layer with some specified options:

```toml
[[layers]]
name = "shell"
default_position = "top"
default_height = 30
```

### Disable layers

Some layers are enabled by defalut, here is an example for disable `shell` layer:

```toml
[[layers]]
name = "shell"
enable = false
```

<!-- SpaceVim layer list start -->

## Available layers

| Name                                                  | Description                                                                                                                                                         |
| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [VersionControl](VersionControl/)                     | This layers provides general version control feature for vim. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc…                         |
| [autocomplete](autocomplete/)                         | Autocomplete code within SpaceVim, fuzzy find the candidates from multiple completion sources, expand snippet before cursor automatically                           |
| [chat](chat/)                                         | SpaceVim chatting layer provide chatting with qq and weixin in vim.                                                                                                 |
| [checkers](checkers/)                                 | Syntax checking automatically within SpaceVim, display error on the sign column and statusline.                                                                     |
| [chinese](chinese/)                                   | Layer for chinese users, include chinese docs and runtime messages                                                                                                  |
| [colorscheme](colorscheme/)                           | colorscheme provides a list of colorscheme for SpaceVim, default colorscheme is gruvbox with dark theme.                                                            |
| [cscope](cscope/)                                     | cscope layer provides a smart cscope and pycscope helper for SpaceVim, help users win at cscope                                                                     |
| [ctrlp](ctrlp/)                                       | This layers provide a heavily customized ctrlp centric work-flow                                                                                                    |
| [debug](debug/)                                       | This layer provide debug workflow support in SpaceVim                                                                                                               |
| [default](default/)                                   | lt layer contains none plugins, but it has some better default config for vim and neovim                                                                            |
| [denite](denite/)                                     | This layers provide a heavily customized Denite centric work-flow                                                                                                   |
| [fzf](fzf/)                                           | This layers provide a heavily customized fzf centric work-flow                                                                                                      |
| [git](git/)                                           | This layers adds extensive support for git                                                                                                                          |
| [github](github/)                                     | This layer provides GitHub integration for SpaceVim                                                                                                                 |
| [lang#c](lang/c/)                                     | c/c++/object-c language support for SpaceVim, include code completion, jump to definition, quick runner.                                                            |
| [lang#csharp](lang/csharp/)                           | This layer is for csharp development                                                                                                                                |
| [lang#dart](lang/dart/)                               | This layer is for dart development, provide autocompletion, syntax checking, code format for dart file.                                                             |
| [lang#elixir](lang/elixir/)                           | This layer is for elixir development, provide autocompletion, syntax checking, code format for elixir file.                                                         |
| [lang#go](lang/go/)                                   | This layer is for golang development. It also provides additional language-specific key mappings.                                                                   |
| [lang#haskell](lang/haskell/)                         | haskell language support for SpaceVim, includes code completion, syntax checking, jumping to definition, also provides language server protocol support for haskell |
| [lang#html](lang/html/)                               | Edit html in SpaceVim, with this layer, this layer provides code completion, syntax checking and code formatting for html.                                          |
| [lang#java](lang/java/)                               | This layer is for Java development. All the features such as code completion, formatting, syntax checking, REPL and debug have be done in this layer.               |
| [lang#javascript](lang/javascript/)                   | This layer is for JavaScript development                                                                                                                            |
| [lang#lisp](lang/lisp/)                               | This layer is for lisp development, provide autocompletion, syntax checking, code format for lisp file.                                                             |
| [lang#lua](lang/lua/)                                 | This layer is for lua development, provide autocompletion, syntax checking, code format for lua file.                                                               |
| [lang#markdown](lang/markdown/)                       | Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown file.                                           |
| [lang#ocaml](lang/ocaml/)                             | This layer is for Python development, provide autocompletion, syntax checking, code format for ocaml file.                                                          |
| [lang#php](lang/php/)                                 | This layer adds PHP language support to SpaceVim                                                                                                                    |
| [lang#python](lang/python/)                           | This layer is for Python development, provide autocompletion, syntax checking, code format for python file.                                                         |
| [lang#ruby](lang/ruby/)                               | This layer is for ruby development, provide autocompletion, syntax checking, code format for ruby file.                                                             |
| [lang#typescript](lang/typescript/)                   | This layer is for TypeScript development                                                                                                                            |
| [lang#vim](lang/vim/)                                 | This layer is for writting vim script, including code completion, syntax checking and buffer formatting                                                             |
| [language-server-protocol](language-server-protocol/) | This layers provides language server protocol for vim and neovim                                                                                                    |
| [leaderf](leaderf/)                                   | This layers provide a heavily customized LeaderF centric work-flow                                                                                                  |
| [shell](shell/)                                       | This layer provide shell support in SpaceVim                                                                                                                        |
| [tags](tags/)                                         | This layer provide tags manager for project                                                                                                                         |
| [tools#dash](tools/dash/)                             | This layer provides Dash integration for SpaceVim                                                                                                                   |
| [tools](tools/)                                       | This layer provides some tools for vim                                                                                                                              |
| [ui](ui/)                                             | Awesome UI layer for SpaceVim, provide IDE-like UI for neovim and vim in both TUI and GUI                                                                           |
| [unite](unite/)                                       | This layers provide a heavily customized Unite centric work-flow                                                                                                    |

<!-- SpaceVim layer list end -->

<!-- vim:set nowrap: -->
Update layers page 2017-09-23 20:02:23 +08:00			`---`
			`title: Available layers`
HTML Improvements (#1707) * HTML Improvements * Update html * Improve html * Fix up * Update layers index * Update development page * Update layers index * Update layers index * Update layers index * Update layers index * Update layers index 2018-05-12 19:01:00 +08:00			`description: "A guide for managing SpaceVim with layers, tell you how to enable and disable a layer, also list all available layers in SpaceVim"`
Update layers page 2017-09-23 20:02:23 +08:00			`---`

HTML Improvements (#1707) * HTML Improvements * Update html * Improve html * Fix up * Update layers index * Update development page * Update layers index * Update layers index * Update layers index * Update layers index * Update layers index 2018-05-12 19:01:00 +08:00			`# Available layers`

Update doc for layers 2017-12-21 20:13:56 +08:00			`<!-- vim-markdown-toc GFM -->`

			`- [Introduction](#introduction)`
			`- [Enable layers](#enable-layers)`
			`- [Disable layers](#disable-layers)`
			`- [Available layers](#available-layers)`

			`<!-- vim-markdown-toc -->`

Update layers page 2017-09-23 20:02:23 +08:00			`## Introduction`

Update doc for layers 2017-12-21 20:13:56 +08:00			`SpaceVim is a community-driven vim distribution that seeks to provide layer feature.`
			`Layers help collect related packages together to provide features.`
			`This approach helps keep configuration organized and reduces overhead for the user by`
			`keeping them from having to think about what packages to install.`

			`### Enable layers`

HTML Improvements (#1707) * HTML Improvements * Update html * Improve html * Fix up * Update layers index * Update development page * Update layers index * Update layers index * Update layers index * Update layers index * Update layers index 2018-05-12 19:01:00 +08:00			By default only `autocomplete`, `checkers` layer are enabled. To enable a specific layer
			`you need to edit SpaceVim configuration file. The key binding for opening SpaceVim`
			configuration file is `SPC f v d`

Update doc for layers 2017-12-21 20:13:56 +08:00			here is an example for loadding `shell` layer with some specified options:
Update layers page 2017-09-23 20:02:23 +08:00
HTML Improvements (#1707) * HTML Improvements * Update html * Improve html * Fix up * Update layers index * Update development page * Update layers index * Update layers index * Update layers index * Update layers index * Update layers index 2018-05-12 19:01:00 +08:00			```toml
			`[[layers]]`
			`name = "shell"`
			`default_position = "top"`
			`default_height = 30`
Update layers page 2017-09-23 20:02:23 +08:00			```

Update doc for layers 2017-12-21 20:13:56 +08:00			`### Disable layers`

			Some layers are enabled by defalut, here is an example for disable `shell` layer:

HTML Improvements (#1707) * HTML Improvements * Update html * Improve html * Fix up * Update layers index * Update development page * Update layers index * Update layers index * Update layers index * Update layers index * Update layers index 2018-05-12 19:01:00 +08:00			```toml
			`[[layers]]`
			`name = "shell"`
			`enable = false`
Update doc for layers 2017-12-21 20:13:56 +08:00			```

Add func for update layer list 2017-12-12 09:08:56 +08:00			`<!-- SpaceVim layer list start -->`

Update layers page 2017-09-23 20:02:23 +08:00			`## Available layers`

HTML Improvements (#1707) * HTML Improvements * Update html * Improve html * Fix up * Update layers index * Update development page * Update layers index * Update layers index * Update layers index * Update layers index * Update layers index 2018-05-12 19:01:00 +08:00			`\| Name \| Description \|`
			`\| ----------------------------------------------------- \| ------------------------------------------------------------------------------------------------------------------------------------------------------------------- \|`
			`\| [VersionControl](VersionControl/) \| This layers provides general version control feature for vim. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc… \|`
			`\| [autocomplete](autocomplete/) \| Autocomplete code within SpaceVim, fuzzy find the candidates from multiple completion sources, expand snippet before cursor automatically \|`
			`\| [chat](chat/) \| SpaceVim chatting layer provide chatting with qq and weixin in vim. \|`
			`\| [checkers](checkers/) \| Syntax checking automatically within SpaceVim, display error on the sign column and statusline. \|`
			`\| [chinese](chinese/) \| Layer for chinese users, include chinese docs and runtime messages \|`
			`\| [colorscheme](colorscheme/) \| colorscheme provides a list of colorscheme for SpaceVim, default colorscheme is gruvbox with dark theme. \|`
			`\| [cscope](cscope/) \| cscope layer provides a smart cscope and pycscope helper for SpaceVim, help users win at cscope \|`
			`\| [ctrlp](ctrlp/) \| This layers provide a heavily customized ctrlp centric work-flow \|`
			`\| [debug](debug/) \| This layer provide debug workflow support in SpaceVim \|`
			`\| [default](default/) \| lt layer contains none plugins, but it has some better default config for vim and neovim \|`
			`\| [denite](denite/) \| This layers provide a heavily customized Denite centric work-flow \|`
			`\| [fzf](fzf/) \| This layers provide a heavily customized fzf centric work-flow \|`
			`\| [git](git/) \| This layers adds extensive support for git \|`
			`\| [github](github/) \| This layer provides GitHub integration for SpaceVim \|`
			`\| [lang#c](lang/c/) \| c/c++/object-c language support for SpaceVim, include code completion, jump to definition, quick runner. \|`
			`\| [lang#csharp](lang/csharp/) \| This layer is for csharp development \|`
			`\| [lang#dart](lang/dart/) \| This layer is for dart development, provide autocompletion, syntax checking, code format for dart file. \|`
			`\| [lang#elixir](lang/elixir/) \| This layer is for elixir development, provide autocompletion, syntax checking, code format for elixir file. \|`
			`\| [lang#go](lang/go/) \| This layer is for golang development. It also provides additional language-specific key mappings. \|`
			`\| [lang#haskell](lang/haskell/) \| haskell language support for SpaceVim, includes code completion, syntax checking, jumping to definition, also provides language server protocol support for haskell \|`
			`\| [lang#html](lang/html/) \| Edit html in SpaceVim, with this layer, this layer provides code completion, syntax checking and code formatting for html. \|`
			`\| [lang#java](lang/java/) \| This layer is for Java development. All the features such as code completion, formatting, syntax checking, REPL and debug have be done in this layer. \|`
Type: JaveScript --> JavaScript (#1753) 2018-05-25 21:25:05 +08:00			`\| [lang#javascript](lang/javascript/) \| This layer is for JavaScript development \|`
HTML Improvements (#1707) * HTML Improvements * Update html * Improve html * Fix up * Update layers index * Update development page * Update layers index * Update layers index * Update layers index * Update layers index * Update layers index 2018-05-12 19:01:00 +08:00			`\| [lang#lisp](lang/lisp/) \| This layer is for lisp development, provide autocompletion, syntax checking, code format for lisp file. \|`
			`\| [lang#lua](lang/lua/) \| This layer is for lua development, provide autocompletion, syntax checking, code format for lua file. \|`
			`\| [lang#markdown](lang/markdown/) \| Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown file. \|`
			`\| [lang#ocaml](lang/ocaml/) \| This layer is for Python development, provide autocompletion, syntax checking, code format for ocaml file. \|`
			`\| [lang#php](lang/php/) \| This layer adds PHP language support to SpaceVim \|`
			`\| [lang#python](lang/python/) \| This layer is for Python development, provide autocompletion, syntax checking, code format for python file. \|`
			`\| [lang#ruby](lang/ruby/) \| This layer is for ruby development, provide autocompletion, syntax checking, code format for ruby file. \|`
			`\| [lang#typescript](lang/typescript/) \| This layer is for TypeScript development \|`
			`\| [lang#vim](lang/vim/) \| This layer is for writting vim script, including code completion, syntax checking and buffer formatting \|`
			`\| [language-server-protocol](language-server-protocol/) \| This layers provides language server protocol for vim and neovim \|`
			`\| [leaderf](leaderf/) \| This layers provide a heavily customized LeaderF centric work-flow \|`
			`\| [shell](shell/) \| This layer provide shell support in SpaceVim \|`
			`\| [tags](tags/) \| This layer provide tags manager for project \|`
			`\| [tools#dash](tools/dash/) \| This layer provides Dash integration for SpaceVim \|`
			`\| [tools](tools/) \| This layer provides some tools for vim \|`
			`\| [ui](ui/) \| Awesome UI layer for SpaceVim, provide IDE-like UI for neovim and vim in both TUI and GUI \|`
			`\| [unite](unite/) \| This layers provide a heavily customized Unite centric work-flow \|`
Fix indent 2018-02-25 01:06:18 +08:00
Add func for update layer list 2017-12-12 09:08:56 +08:00			`<!-- SpaceVim layer list end -->`
Fix layer func 2017-12-12 09:22:00 +08:00
			`<!-- vim:set nowrap: -->`