1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-23 22:30:04 +08:00
SpaceVim/docs/layers.md
2021-06-21 20:39:29 +08:00

30 KiB

title description
Available layers A guide for managing SpaceVim with layers, How to enable and disable a layer, and list all available layers in SpaceVim

Home >> Layers

Introduction

SpaceVim is a community-driven Vim distribution that seeks to provides a layers feature.

Layers help collecting related packages together to provides 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 SpaceVim enables these layers:

  • autocomplete
  • checkers
  • format
  • edit
  • ui
  • core
  • core#banner
  • core#statusline
  • core#tabline

To enable a specific layer you need to edit SpaceVim's custom configuration files. The key binding for opening the configuration files.s SPC f v d.

The following example shows how to load shell layer with some specified options:

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

Disable layers

Some layers are enabled by default. The following example shows how to disable shell layer:

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

Available layers

Name Description
VersionControl This layer provides general version control features for vim. It should work with all VC backends such as Git, Mercurial, Bazaar, SVN, etc…
autocomplete Autocomplete code within SpaceVim, fuzzy find the candidates from multiple completion sources, and expand snippets before cursor automatically
chat SpaceVim chatting layer provides chatting with qq and weixin in vim.
checkers Automatic syntax checking within SpaceVim, displays errors on the sign column and statusline.
chinese Layer for chinese users, includes chinese docs and runtime messages
colorscheme colorscheme provides a list of colorschemes for SpaceVim, default colorscheme is gruvbox with dark theme.
core#banner This layer provides many default banners on the welcome page.
core#statusline This layer provides the default statusline for SpaceVim
core#tabline SpaceVim core#tabline layer provides a better tabline for SpaceVim
core SpaceVim core layer provides many default key bindings and features.
cscope cscope layer provides a smart cscope and pycscope helpers for SpaceVim, help users win at cscope
ctrlp This layer provides a heavily customized ctrlp centric work-flow
ctrlspace This layer provides a customized CtrlSpace centric workflow
debug This layer provides debug workflow support in SpaceVim
default SpaceVim default layer contains no plugins, but It provides some better default config for SpaceVim.
denite This layer provides a heavily customized Denite centric work-flow
edit Improve code editing exprience in SpaceVim, provides more text objects.
floobits This layer adds support for the peer programming tool floobits to SpaceVim.
foldsearch This layer provides functions that fold away lines that don't match a specific search pattern.
format Code formatting layer for SpaceVim, includes a variety of formatters for many files.pes
fzf This layers provides a heavily customized fzf centric work-flow
git This layer adds extensive support for git
github This layer provides GitHub integration for SpaceVim
gtags This layer provides gtags manager for project
japanese Layer for japanese users, includes japanese docs and runtime messages
lang#WebAssembly This layer adds WebAssembly support to SpaceVim
lang#actionscript This layer is for actionscript syntax highlighting
lang#agda This layer adds Agda language support to SpaceVim.
lang#asciidoc Edit AsciiDoc within vim, autopreview AsciiDoc in the default browser, with this layer you can also format AsciiDoc files.
lang#aspectj AspectJ language support, include syntax highlighting.
lang#assembly This layer adds Assembly language support to SpaceVim, including syntax highlighting.
lang#autohotkey This layer adds AutohotKey language support to SpaceVim.
lang#batch This layer is for DOS batch files.evelopment, provides syntax highlighting, code runner and repl support for batch files.
lang#c C/C++/Object-C language support for SpaceVim, including code completion, jump to definition, and quick runner.
lang#chapel This layer is for chapel development, provides syntax checking, code runner and repl support for chapel files.
lang#clojure This layer is for Clojure development, provides autocompletion, syntax checking, and code formatting for Clojure files.
lang#coffeescript This layer is for CoffeeScript development, provides autocompletion, syntax checking, code formatting for CoffeeScript files.
lang#crystal This layer is for crystal development, provides syntax checking, code runner and repl support for crystal files.
lang#csharp csharp language layer, including syntax highlighting, and asynchronous code runner.
lang#d This layer is for d development, provides syntax checking, and code runner support for d files.
lang#dart This layer is for Dart development, provides autocompletion, syntax checking, and code formatting for Dart files.
[lang#dockerfiles.lang/dockerfile/) DockerFile language support, including syntax highlighting and code formatting.
lang#e This layer is for e development, provides syntax checking, code runner and repl support for e files.
lang#eiffel This layer is for eiffel development, provides syntax highlighting, and auto-indent for eiffel files.
lang#elixir This layer is for Elixir development, provides autocompletion, syntax checking, and code formatting for Elixir files.
lang#elm This layer is for Elm development, provides autocompletion, syntax checking, code formatting for Elm files.
lang#erlang This layer is for Erlang development, provides autocompletion, syntax checking, and code formatting for Erlang files.
lang#extra This layer adds support for extra languages to SpaceVim
lang#fortran This layer is for fortran development, provides syntax checking, and code runner for fortran files.
lang#foxpro This layer is for Visual FoxPro development, provides syntax highlighting for foxpro files.
lang#fsharp This layer adds FSharp language support to SpaceVim
lang#go This layer is for golang development. It also provides additional language-specific key mappings.
lang#goby This layer is for goby development, provides syntax checking, code runner and repl support for goby files.
lang#gosu This layer is for gosu development, provides syntax checking, code runner and repl support for gosu files.
lang#graphql This layer adds GraphQL files.upport to SpaceVim
lang#groovy This layer is for Groovy development, provides syntax checking, code runner and repl support for groovy files.
lang#hack This layer is for hack development, provides syntax checking, code runner and repl support for hack files.
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 Edit html in SpaceVim, with this layer, this layer provides code completion, syntax checking and code formatting for html.
lang#hy This layer is for hy development, provides syntax checking, code runner and repl support for hy files.
lang#idris This layer is for idris development, provides syntax checking, code runner and repl support for idris files.
lang#io This layer is for io development, provides code runner and repl support for io files.
lang#ipynb This layer adds Jupyter Notebook support to SpaceVim
lang#j This layer is for j development, provides syntax checking and repl support for j files.
lang#janet This layer is for janet development, provides code runner and repl support for janet files.
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 This layer provides JavaScript development support for SpaceVim, including code completion, syntax highlighting and syntax checking
lang#julia This layer is for Julia development, provides autocompletion, syntax checking and code formatting
lang#kotlin This layer adds Kotlin language support to SpaceVim, including syntax highlighting, code runner and REPL support.
lang#lasso Lasso language support, include syntax highlighting.
lang#latex This layer provides support for writing LaTeX documents, including syntax highlighting, code completion, formatting etc.
lang#lisp This layer is for Common Lisp development, provides autocompletion, syntax checking, code format for Common Lisp files.
lang#livescript This layer is for livescript development, provides syntax checking, code runner and repl support for livescript files.
lang#lua This layer is for Lua development, provides autocompletion, syntax checking, code format for Lua files.
lang#markdown Edit markdown within vim, autopreview markdown in the default browser, with this layer you can also format markdown files.
lang#matlab This layer adds matlab language support to SpaceVim, including syntax highlighting.
lang#moonscript This layer is for moonscript development, provides syntax checking, code runner and repl support for moonscript files.
lang#nim This layer adds Nim language support to SpaceVim
lang#nix This layer adds Nix language support to SpaceVim.
lang#ocaml This layer is for OCaml development, provides autocompletion, syntax checking, code format for OCaml files.
lang#pact This layer is for pact development, provides syntax checking, code runner and repl support for pact files.
lang#pascal This layer is for pascal development, provides syntax highlighting, code runner for pascal files.
lang#perl This layer is for Perl development, provides autocompletion, syntax checking, code format for Perl files.
lang#php PHP language support, including code completion, syntax lint and code runner
lang#plantuml This layer is for PlantUML development, syntax highlighting for PlantUML files.
lang#pony This layer is for pony development, provides syntax checking, code runner and repl support for pony files.
lang#povray This layer is for povray development, provides syntax highlighting, viewing images.
lang#powershell This layer is for powershell development, provides syntax checking, code runner and repl support for powershell files.
lang#processing This layer is for working on Processing sketches. It provides syntax checking and an app runner
lang#prolog This layer is for Prolog development, provides syntax checking, code runner and repl support for prolog files.
lang#puppet This layer adds Puppet language support to SpaceVim
lang#purescript This layer is for PureScript development, provides autocompletion, syntax checking, code format for PureScript files.
lang#python This layer is for Python development, provides autocompletion, syntax checking, code format for Python files.
lang#r This layer is for R development, provides autocompletion, syntax checking and code format.
lang#racket This layer adds racket language support to SpaceVim, including syntax highlighting, code runner and REPL support.
lang#reason This layer is for reason development, provides syntax checking, code runner and repl support for reason files.
lang#red This layer is for Red development, provides autocompletion, syntax checking and code format.
lang#rescript This layer is for ReScript development, provides syntax checking, code runner and repl support for ReScript files.
lang#ring This layer is for ring development, provides syntax checking, code runner and repl support for ring files.
lang#rst Take Notes in reStructuredText, autopreview in the default browser.
lang#ruby This layer is for Ruby development, provides autocompletion, syntax checking, code format for Ruby files.
lang#rust This layer is for Rust development, provides autocompletion, syntax checking, code format for Rust files.
lang#scala This layer adds Scala language support to SpaceVim
lang#scheme This layer adds Scheme language support to SpaceVim
lang#sh Shell script development layer, provides autocompletion, syntax checking, code format for bash and zsh script.
lang#slim This layer is for slim development, includes syntax highlighting for slim files.
lang#sml This layer is for Standard ML development, provides syntax highlighting and repl support for sml files.
lang#swift swift language support for SpaceVim, includes code completion, syntax highlighting
lang#tcl This layer is for Tcl development, provides syntax checking, code runner and repl support for tcl files.
lang#toml This layer is for toml development, provides syntax checking, indent etc.
lang#typescript This layer is for TypeScript development, includding code completion, Syntax lint, and doc generation.
lang#v This layer is for v development, provides syntax checking, code runner and repl support for v files.
lang#vbnet This layer is for Visual Basic .NET development, provides code runner vb files.
lang#vim This layer is for writing Vimscript, including code completion, syntax checking and buffer formatting
lang#vue This layer adds Vue language support to SpaceVim
lang#wolfram This layer is for wolfram development, provides syntax checking, code runner and repl support for wolfram files.
lang#xml This layer is for xml development, provides syntax checking, indent etc.
lang#zig This layer is for zig development, provides code runner support for zig files.
language-server-protocol This layers provides language server protocol for vim and neovim
leaderf This layers provides a heavily customized LeaderF centric work-flow
shell This layer provides shell support in SpaceVim
sudo sudo layer provides ability to read and write files.levated privileges in SpaceVim
test This layer allows to run tests directly on SpaceVim
tmux This layers adds extensive support for tmux
tools#dash This layer provides Dash integration for SpaceVim
tools#mpv This layer provides mpv integration for SpaceVim
tools#zeal This layer provides Zeal integration for SpaceVim
tools This layer provides some tools for vim
ui Awesome UI layer for SpaceVim, provides IDE-like UI for neovim and vim in both TUI and GUI
unite This layers provides a heavily customized Unite centric work-flow