diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim index 4dae49bc7..ce0e64108 100644 --- a/autoload/SpaceVim.vim +++ b/autoload/SpaceVim.vim @@ -152,6 +152,9 @@ let g:spacevim_enable_cursorline = 1 let g:spacevim_statusline_separator = 'arrow' let g:spacevim_statusline_inactive_separator = 'arrow' "" +" Enable/Disable unicode symbols in statusline +let g:spacevim_statusline_unicode_symbols = 1 +"" " Enable/Disable cursorcolumn. Default is 0, cursorcolumn will be " highlighted in normal mode. To enable this feature: " > @@ -269,6 +272,7 @@ let g:spacevim_buffer_index_type = 0 " " 0: 1 ➛ ➊ " " 1: 1 ➛ ➀ " " 2: 1 ➛ ⓵ +" " 3: 1 ➛ 1 " let g:spacevim_windows_index_type = 1 " < let g:spacevim_windows_index_type = 0 diff --git a/autoload/SpaceVim/layers/core/statusline.vim b/autoload/SpaceVim/layers/core/statusline.vim index 977fd166f..abc112325 100644 --- a/autoload/SpaceVim/layers/core/statusline.vim +++ b/autoload/SpaceVim/layers/core/statusline.vim @@ -34,26 +34,32 @@ let s:loaded_modes = ['syntax-checking'] let s:modes = { \ 'center-cursor': { \ 'icon' : '⊝', + \ 'icon_asc' : '-', \ 'desc' : 'centered-cursor mode', \ }, \ 'hi-characters-for-long-lines' :{ \ 'icon' : '⑧', + \ 'icon_asc' : '8', \ 'desc' : 'toggle highlight of characters for long lines', \ }, \ 'fill-column-indicator' :{ \ 'icon' : s:MESSLETTERS.circled_letter('f'), + \ 'icon_asc' : 'f', \ 'desc' : 'fill-column-indicator mode', \ }, \ 'syntax-checking' :{ \ 'icon' : s:MESSLETTERS.circled_letter('s'), + \ 'icon_asc' : 's', \ 'desc' : 'syntax-checking mode', \ }, \ 'spell-checking' :{ \ 'icon' : s:MESSLETTERS.circled_letter('S'), + \ 'icon_asc' : 'S', \ 'desc' : 'spell-checking mode', \ }, \ 'whitespace' :{ \ 'icon' : s:MESSLETTERS.circled_letter('w'), + \ 'icon_asc' : 'w', \ 'desc' : 'whitespace mode', \ }, \ } @@ -126,9 +132,17 @@ endif function! s:winnr(...) abort if a:0 > 1 - return ' ' . s:MESSLETTERS.circled_num(winnr(), g:spacevim_windows_index_type) . ' ' + if g:spacevim_windows_index_type == 3 + return ' ' . winnr() . ' ' + else + return ' ' . s:MESSLETTERS.circled_num(winnr(), g:spacevim_windows_index_type) . ' ' + endif else - return '%{SpaceVim#layers#core#statusline#mode(mode())} ' . s:MESSLETTERS.circled_num(winnr(), g:spacevim_windows_index_type) . ' ' + if g:spacevim_windows_index_type == 3 + return '%{SpaceVim#layers#core#statusline#mode(mode())} ' . winnr() . ' ' + else + return '%{SpaceVim#layers#core#statusline#mode(mode())} ' . s:MESSLETTERS.circled_num(winnr(), g:spacevim_windows_index_type) . ' ' + endif endif endfunction @@ -169,7 +183,11 @@ endfunction function! s:modes() abort let m = ' ❖ ' for mode in s:loaded_modes - let m .= s:modes[mode].icon . ' ' + if g:spacevim_statusline_unicode_symbols == 1 + let m .= s:modes[mode].icon . ' ' + else + let m .= s:modes[mode].icon_asc . ' ' + endif endfor return m . ' ' endfunction @@ -396,17 +414,17 @@ endfunction " +- a:marked : The number of marked files, or a comma separated list of " the marked filenames. function! SpaceVim#layers#core#statusline#ctrlp(focus, byfname, regex, prev, item, next, marked) abort - return s:STATUSLINE.build([' Ctrlp ', ' ' . a:prev . ' ', ' ' . a:item . ' ', ' ' . a:next . ' '], - \ [' ' . a:focus . ' ', ' ' . a:byfname . ' ', ' ' . getcwd() . ' '], s:lsep, s:rsep, - \ 'SpaceVim_statusline_a_bold', 'SpaceVim_statusline_b', 'SpaceVim_statusline_c', 'SpaceVim_statusline_z') + return s:STATUSLINE.build([' Ctrlp ', ' ' . a:prev . ' ', ' ' . a:item . ' ', ' ' . a:next . ' '], + \ [' ' . a:focus . ' ', ' ' . a:byfname . ' ', ' ' . getcwd() . ' '], s:lsep, s:rsep, + \ 'SpaceVim_statusline_a_bold', 'SpaceVim_statusline_b', 'SpaceVim_statusline_c', 'SpaceVim_statusline_z') endfunction " a:str : Either the number of files scanned so far, or a string indicating " the current directory is being scanned with a user_command. function! SpaceVim#layers#core#statusline#ctrlp_status(str) abort - return s:STATUSLINE.build([' Ctrlp ', ' ' . a:str . ' '], - \ [' ' . getcwd() . ' '], s:lsep, s:rsep, - \ 'SpaceVim_statusline_a', 'SpaceVim_statusline_b', 'SpaceVim_statusline_c', 'SpaceVim_statusline_z') + return s:STATUSLINE.build([' Ctrlp ', ' ' . a:str . ' '], + \ [' ' . getcwd() . ' '], s:lsep, s:rsep, + \ 'SpaceVim_statusline_a', 'SpaceVim_statusline_b', 'SpaceVim_statusline_c', 'SpaceVim_statusline_z') endfunction function! SpaceVim#layers#core#statusline#jump(i) abort diff --git a/autoload/SpaceVim/layers/lang/javascript.vim b/autoload/SpaceVim/layers/lang/javascript.vim index 78c7c0527..86775ea3b 100644 --- a/autoload/SpaceVim/layers/lang/javascript.vim +++ b/autoload/SpaceVim/layers/lang/javascript.vim @@ -15,8 +15,22 @@ function! SpaceVim#layers#lang#javascript#plugins() abort return plugins endfunction +let s:auto_fix = 0 + +function! SpaceVim#layers#lang#javascript#set_variable(var) abort + let s:auto_fix = get(a:var, 'auto_fix', s:auto_fix) +endfunction + function! SpaceVim#layers#lang#javascript#config() abort call SpaceVim#mapping#gd#add('javascript', function('s:gotodef')) + if s:auto_fix + " Only use eslint + let g:neomake_javascript_enabled_makers = ['eslint'] + " Use the fix option of eslint + let g:neomake_javascript_eslint_args = ['-f', 'compact', '--fix'] + au User NeomakeFinished checktime + au FocusGained * checktime + endif endfunction function! s:gotodef() abort diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index 98504e8cf..3666dcb49 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -188,6 +188,9 @@ Set the statusline separators of statusline, default is 'arrow' See more details in: http://spacevim.org/documentation/#statusline + *g:spacevim_statusline_unicode_symbols* +Enable/Disable unicode symbols in statusline + *g:spacevim_enable_cursorcolumn* Enable/Disable cursorcolumn. Default is 0, cursorcolumn will be highlighted in normal mode. To enable this feature: @@ -300,6 +303,7 @@ Set SpaceVim windows index type, default is 0. " 0: 1 ➛ ➊ " 1: 1 ➛ ➀ " 2: 1 ➛ ⓵ + " 3: 1 ➛ 1 let g:spacevim_windows_index_type = 1 < diff --git a/docs/Gemfile b/docs/Gemfile index f8dd7464e..de67ab6c8 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,3 +1,4 @@ source 'https://rubygems.org' gem 'github-pages', group: :jekyll_plugins gem 'jekyll-redirect-from', group: :jekyll_plugins +gem 'jekyll-seo-tag' diff --git a/docs/README_zh_cn.md b/docs/README_zh_cn.md index 854ca1fc6..819d26524 100644 --- a/docs/README_zh_cn.md +++ b/docs/README_zh_cn.md @@ -1,3 +1,9 @@ +--- +title: "SpaceVim 中文手册" +description: "SpaceVim 是一个社区驱动的 Vim 配置,内含多种语言模块,提供了代码补全、语法检查、跳转等多种 IDE 特性。" +--- + + # SpaceVim 中文手册 [![Build Status](https://travis-ci.org/SpaceVim/SpaceVim.svg?branch=dev)](https://travis-ci.org/SpaceVim/SpaceVim) diff --git a/docs/_config.yml b/docs/_config.yml index cf23c2cda..d4760ed6c 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,15 +1,29 @@ theme: jekyll-theme-midnight title: SpaceVim -description: A community-driven Vim distribution +description: A community-driven vim distribution show_downloads: false google_analytics: UA-89745542-1 project_repo_url: https://github.com/SpaceVim/SpaceVim url: https://spacevim.org - +logo: https://spacevim.org/SpaceVim.png permalink: /:title/ plugins: - jekyll-redirect-from - jekyll-sitemap + - jekyll-seo-tag github: [metadata] + +author: + name: Shidong Wang + twitter: SpaceVim +twitter: + username: "@SpaceVim" + +social: + name: SpaceVim + links: + - https://twitter.com/SpaceVim + - https://github.com/SpaceVim/SpaceVim + - https://www.reddit.com/r/SpaceVim/ diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 1eb0b706b..b5dea63e3 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -1,127 +1,122 @@ - - - + + {% seo %} + + + + - - - - - - - - - {{ page.title | default: Home }} - SpaceVim - - - - + + + {{ page.title | default: Home }} - SpaceVim + + + + - - - - - - - - - + + Fork me on GitHub -
+
-
-
-

{{ site.title | default: site.github.repository_name }}

-

{{ site.description | default: site.github.project_tagline }}

-
-

- Home | - About | - Documentation | - Development | - Community | - Sponsors -

-
-
+
+
+

{{ site.title | default: site.github.repository_name }}

+

{{ site.description | default: site.github.project_tagline }}

+
+

+ Home | + About | + Documentation | + Development | + Community | + Sponsors +

+
+
- {{ content }} + {{ content }} -
+
-
+
+ + {% if site.google_analytics %} + + + {% endif %} + + + +

+ Hosted on GitHub — Theme by mattgraham +

+
- {% if site.google_analytics %} - - - {% endif %} - - - -

- Hosted on GitHub — Theme by mattgraham -

-
diff --git a/docs/about.md b/docs/about.md index ceeac637b..be6a2c881 100644 --- a/docs/about.md +++ b/docs/about.md @@ -1,5 +1,6 @@ --- title: "About" +description: "Introduction about SpaceVim organization." --- # About SpaceVim diff --git a/docs/development.md b/docs/development.md index 49c97a779..886c53174 100644 --- a/docs/development.md +++ b/docs/development.md @@ -1,5 +1,6 @@ --- title: "Development" +description: "A guide for contributing to SpaceVim." --- # Development diff --git a/docs/documentation.md b/docs/documentation.md index f0719abf0..2073b851a 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -1,137 +1,138 @@ --- title: "Documentation" +description: "A guide for using SpaceVim." --- # SpaceVim Documentation -* [Core Pillars](#core-pillars) - * [Mnemonic](#mnemonic) - * [Discoverable](#discoverable) - * [Consistent](#consistent) - * [Crowd-Configured](#crowd-configured) -* [Highlighted features](#highlighted-features) -* [Screenshots](#screenshots) - * [welcome page](#welcome-page) - * [working flow](#working-flow) -* [Who can benefit from this?](#who-can-benefit-from-this) -* [Update and Rollback](#update-and-rollback) - * [Update SpaceVim itself](#update-spacevim-itself) - * [Automatic Updates](#automatic-updates) - * [Updating from the SpaceVim Buffer](#updating-from-the-spacevim-buffer) - * [Updating Manually with git](#updating-manually-with-git) - * [Update plugins](#update-plugins) -* [Configuration layers](#configuration-layers) -* [Custom Configuration](#custom-configuration) - * [Automatic Generation](#automatic-generation) - * [Alternative directory](#alternative-directory) -* [Concepts](#concepts) - * [Transient-states](#transient-states) -* [Awesome ui](#awesome-ui) - * [Colorschemes](#colorschemes) - * [Font](#font) - * [UI Toggles](#ui-toggles) - * [Statusline && tabline](#statusline--tabline) - * [statusline](#statusline) - * [tabline](#tabline) -* [Manual](#manual) - * [Completion](#completion) - * [Unite/Denite](#unitedenite) - * [Mappings within unite/denite buffer](#mappings-within-unitedenite-buffer) - * [Discovering](#discovering) - * [Mappings](#mappings) - * [Mappings guide](#mappings-guide) - * [Unide/Denite describe key bindings](#unidedenite-describe-key-bindings) - * [Getting help](#getting-help) - * [Available layers](#available-layers) - * [Available plugins in SpaceVim](#available-plugins-in-spacevim) - * [New packages from ELPA repositories](#new-packages-from-elpa-repositories) - * [Toggles](#toggles) - * [Navigating](#navigating) - * [Point/Cursor](#pointcursor) - * [Vim motions with vim-easymotion](#vim-motions-with-vim-easymotion) - * [quick-jump-link mode (TODO)](#quick-jump-link-mode-todo) - * [Unimpaired bindings](#unimpaired-bindings) - * [Jumping, Joining and Splitting](#jumping-joining-and-splitting) - * [Jumping](#jumping) - * [Joining and splitting](#joining-and-splitting) - * [Window manipulation](#window-manipulation) - * [Window manipulation key bindings](#window-manipulation-key-bindings) - * [Buffers and Files](#buffers-and-files) - * [Buffers manipulation key bindings](#buffers-manipulation-key-bindings) - * [Create a new empty buffer](#create-a-new-empty-buffer) - * [Special Buffers](#special-buffers) - * [Files manipulations key bindings](#files-manipulations-key-bindings) - * [Vim and SpaceVim files](#vim-and-spacevim-files) - * [File tree](#file-tree) - * [File tree navigation](#file-tree-navigation) - * [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) - * [Searching in current file](#searching-in-current-file) - * [Searching in all loaded buffers](#searching-in-all-loaded-buffers) - * [Searching in an arbitrary directory](#searching-in-an-arbitrary-directory) - * [Searching in a project](#searching-in-a-project) - * [Background searching in a project](#background-searching-in-a-project) - * [Searching the web](#searching-the-web) - * [Searching on the fly](#searching-on-the-fly) - * [Persistent highlighting](#persistent-highlighting) - * [Editing](#editing) - * [Paste text](#paste-text) - * [Auto-indent pasted text](#auto-indent-pasted-text) - * [Text manipulation commands](#text-manipulation-commands) - * [Text insertion commands](#text-insertion-commands) - * [Commenting](#commenting) - * [Multi-Encodings](#multi-encodings) - * [Errors handling](#errors-handling) - * [Managing projects](#managing-projects) -* [Achievements](#achievements) - * [issues](#issues) - * [Stars, forks and watchers](#stars-forks-and-watchers) -* [Features](#features) - * [Awesome ui](#awesome-ui-1) - * [Mnemonic key bindings](#mnemonic-key-bindings) -* [Language specific mode](#language-specific-mode) -* [Key Mapping](#key-mapping) - * [c/c++ support](#cc-support) - * [go support](#go-support) - * [python support](#python-support) -* [Neovim centric - Dark powered mode of SpaceVim.](#neovim-centric---dark-powered-mode-of-spacevim) -* [Modular configuration](#modular-configuration) -* [Multiple leader mode](#multiple-leader-mode) - * [Global origin vim leader](#global-origin-vim-leader) - * [Local origin vim leader](#local-origin-vim-leader) - * [Windows function leader](#windows-function-leader) - * [Unite work flow leader](#unite-work-flow-leader) -* [Unite centric work-flow](#unite-centric-work-flow) - * [Plugin Highlights](#plugin-highlights) - * [Non Lazy-Loaded Plugins](#non-lazy-loaded-plugins) - * [Lazy-Loaded Plugins](#lazy-loaded-plugins) - * [Language](#language) - * [Commands](#commands) - * [Commands](#commands-1) - * [Completion](#completion-1) - * [Unite](#unite) - * [Operators & Text Objects](#operators--text-objects) - * [Custom Key bindings](#custom-key-bindings) - * [File Operations](#file-operations) - * [Editor UI](#editor-ui) - * [Window Management](#window-management) - * [Native functions](#native-functions) - * [Plugin: Unite](#plugin-unite) - * [Plugin: neocomplete](#plugin-neocomplete) - * [Plugin: NERD Commenter](#plugin-nerd-commenter) - * [Plugin: Goyo and Limelight](#plugin-goyo-and-limelight) - * [Plugin: ChooseWin](#plugin-choosewin) - * [Plugin: Bookmarks](#plugin-bookmarks) - * [Plugin: Gina/Gita](#plugin-ginagita) - * [Plugin: vim-signify](#plugin-vim-signify) - * [Misc Plugins](#misc-plugins) +- [Core Pillars](#core-pillars) + - [Mnemonic](#mnemonic) + - [Discoverable](#discoverable) + - [Consistent](#consistent) + - [Crowd-Configured](#crowd-configured) +- [Highlighted features](#highlighted-features) +- [Screenshots](#screenshots) + - [welcome page](#welcome-page) + - [working flow](#working-flow) +- [Who can benefit from this?](#who-can-benefit-from-this) +- [Update and Rollback](#update-and-rollback) + - [Update SpaceVim itself](#update-spacevim-itself) + - [Automatic Updates](#automatic-updates) + - [Updating from the SpaceVim Buffer](#updating-from-the-spacevim-buffer) + - [Updating Manually with git](#updating-manually-with-git) + - [Update plugins](#update-plugins) +- [Configuration layers](#configuration-layers) +- [Custom Configuration](#custom-configuration) + - [Automatic Generation](#automatic-generation) + - [Alternative directory](#alternative-directory) +- [Concepts](#concepts) + - [Transient-states](#transient-states) +- [Awesome ui](#awesome-ui) + - [Colorschemes](#colorschemes) + - [Font](#font) + - [UI Toggles](#ui-toggles) + - [Statusline && tabline](#statusline--tabline) + - [statusline](#statusline) + - [tabline](#tabline) +- [Manual](#manual) + - [Completion](#completion) + - [Unite/Denite](#unitedenite) + - [Mappings within unite/denite buffer](#mappings-within-unitedenite-buffer) + - [Discovering](#discovering) + - [Mappings](#mappings) + - [Mappings guide](#mappings-guide) + - [Unide/Denite describe key bindings](#unidedenite-describe-key-bindings) + - [Getting help](#getting-help) + - [Available layers](#available-layers) + - [Available plugins in SpaceVim](#available-plugins-in-spacevim) + - [New packages from ELPA repositories](#new-packages-from-elpa-repositories) + - [Toggles](#toggles) + - [Navigating](#navigating) + - [Point/Cursor](#pointcursor) + - [Vim motions with vim-easymotion](#vim-motions-with-vim-easymotion) + - [quick-jump-link mode (TODO)](#quick-jump-link-mode-todo) + - [Unimpaired bindings](#unimpaired-bindings) + - [Jumping, Joining and Splitting](#jumping-joining-and-splitting) + - [Jumping](#jumping) + - [Joining and splitting](#joining-and-splitting) + - [Window manipulation](#window-manipulation) + - [Window manipulation key bindings](#window-manipulation-key-bindings) + - [Buffers and Files](#buffers-and-files) + - [Buffers manipulation key bindings](#buffers-manipulation-key-bindings) + - [Create a new empty buffer](#create-a-new-empty-buffer) + - [Special Buffers](#special-buffers) + - [Files manipulations key bindings](#files-manipulations-key-bindings) + - [Vim and SpaceVim files](#vim-and-spacevim-files) + - [File tree](#file-tree) + - [File tree navigation](#file-tree-navigation) + - [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) + - [Searching in current file](#searching-in-current-file) + - [Searching in all loaded buffers](#searching-in-all-loaded-buffers) + - [Searching in an arbitrary directory](#searching-in-an-arbitrary-directory) + - [Searching in a project](#searching-in-a-project) + - [Background searching in a project](#background-searching-in-a-project) + - [Searching the web](#searching-the-web) + - [Searching on the fly](#searching-on-the-fly) + - [Persistent highlighting](#persistent-highlighting) + - [Editing](#editing) + - [Paste text](#paste-text) + - [Auto-indent pasted text](#auto-indent-pasted-text) + - [Text manipulation commands](#text-manipulation-commands) + - [Text insertion commands](#text-insertion-commands) + - [Commenting](#commenting) + - [Multi-Encodings](#multi-encodings) + - [Errors handling](#errors-handling) + - [Managing projects](#managing-projects) +- [Achievements](#achievements) + - [issues](#issues) + - [Stars, forks and watchers](#stars-forks-and-watchers) +- [Features](#features) + - [Awesome ui](#awesome-ui-1) + - [Mnemonic key bindings](#mnemonic-key-bindings) +- [Language specific mode](#language-specific-mode) +- [Key Mapping](#key-mapping) + - [c/c++ support](#cc-support) + - [go support](#go-support) + - [python support](#python-support) +- [Neovim centric - Dark powered mode of SpaceVim.](#neovim-centric---dark-powered-mode-of-spacevim) +- [Modular configuration](#modular-configuration) +- [Multiple leader mode](#multiple-leader-mode) + - [Global origin vim leader](#global-origin-vim-leader) + - [Local origin vim leader](#local-origin-vim-leader) + - [Windows function leader](#windows-function-leader) + - [Unite work flow leader](#unite-work-flow-leader) +- [Unite centric work-flow](#unite-centric-work-flow) + - [Plugin Highlights](#plugin-highlights) + - [Non Lazy-Loaded Plugins](#non-lazy-loaded-plugins) + - [Lazy-Loaded Plugins](#lazy-loaded-plugins) + - [Language](#language) + - [Commands](#commands) + - [Commands](#commands-1) + - [Completion](#completion-1) + - [Unite](#unite) + - [Operators & Text Objects](#operators--text-objects) + - [Custom Key bindings](#custom-key-bindings) + - [File Operations](#file-operations) + - [Editor UI](#editor-ui) + - [Window Management](#window-management) + - [Native functions](#native-functions) + - [Plugin: Unite](#plugin-unite) + - [Plugin: neocomplete](#plugin-neocomplete) + - [Plugin: NERD Commenter](#plugin-nerd-commenter) + - [Plugin: Goyo and Limelight](#plugin-goyo-and-limelight) + - [Plugin: ChooseWin](#plugin-choosewin) + - [Plugin: Bookmarks](#plugin-bookmarks) + - [Plugin: Gina/Gita](#plugin-ginagita) + - [Plugin: vim-signify](#plugin-vim-signify) + - [Misc Plugins](#misc-plugins) @@ -360,7 +361,7 @@ Some UI indicators can be toggled on and off (toggles start with t and T): | SPC t 8 | highlight any character past the 80th column | | SPC t f | display the fill column (by default the fill column is set to 80) | | SPC t h h | toggle highlight of the current line | -| SPC t h i | toggle highlight indentation levels (TODO) | +| 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 | @@ -480,7 +481,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 nil 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. 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). The letters displayed in the statusline correspond to the key bindings used to toggle them. diff --git a/docs/index.md b/docs/index.md index 48618532f..8ea932c9d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- title: "Home" +description: "SpaceVim is a community-driven vim distribution that seeks to provide layer feature." --- # Introduction diff --git a/docs/layers/index.md b/docs/layers/index.md index fe64d1eac..ab20846d0 100644 --- a/docs/layers/index.md +++ b/docs/layers/index.md @@ -1,4 +1,25 @@ -# SpaceVim Layers +--- +title: Available layers +description: A list of available layers in SpaceVim. +keywords: layer,layers +--- + +## Introduction + +SpaceVim is a community-driven vim distribution that seeks to provide layer feature. here is an example for loadding a layer with some specified options: + +```vim +call SpaceVim#layers#load('shell', + \ { + \ 'default_position' : 'top', + \ 'default_height' : 30, + \ } + \ ) +``` + +## Available layers + +this a list of buildin layers: | Name | Description | Documentation | | ------------- | :-------------------------------: | ---------------------------------------------------------- | diff --git a/docs/layers/lang/javascript.md b/docs/layers/lang/javascript.md new file mode 100644 index 000000000..7cdce7141 --- /dev/null +++ b/docs/layers/lang/javascript.md @@ -0,0 +1,42 @@ +--- +title: "SpaceVim lang#javascript layer" +--- + +# [SpaceVim Layers:](https://spacevim.org/layers) lang#javascript + + + +- [Description](#description) +- [Layer Installation](#layer-installation) +- [Features](#features) +- [Layer configuration](#layer-configuration) + + + +## Description + +This layer is for JavaScript development. + +## Layer Installation + +To use this configuration layer, add `call SpaceVim#layers#load('lang#javascript')` to your custom configuration file. + +## Features + +- auto-completion +- syntax checking +- goto definition +- refernce finder + +## Layer configuration + +`auto_fix`: auto fix problems when save files, disabled by default. if you need this feature, you can load this layer via: + +```vim +call SpaceVim#layers#load('lang#javascript', + \ { + \ 'auto_fix' : 1, + \ } + \ ) + +```