diff --git a/autoload/SpaceVim/layers/lang/markdown.vim b/autoload/SpaceVim/layers/lang/markdown.vim index a2ac46ffa..6cce520a2 100644 --- a/autoload/SpaceVim/layers/lang/markdown.vim +++ b/autoload/SpaceVim/layers/lang/markdown.vim @@ -8,9 +8,12 @@ let s:md_listItemIndent = 1 let s:md_enableWcwidth = 0 +let s:md_listItemChar = '-' function! SpaceVim#layers#lang#markdown#set_variable(var) abort let s:md_listItemIndent = get(a:var, 'listItemIndent', s:md_listItemIndent) let s:md_enableWcwidth = get(a:var, 'enableWcwidth', s:md_enableWcwidth) + let s:md_listItemChar = get(a:var, 'listItemChar', s:md_listItemChar) + let g:vmt_list_item_char = s:md_listItemChar endfunction function! SpaceVim#layers#lang#markdown#plugins() abort diff --git a/docs/documentation.md b/docs/documentation.md index 826448122..2de4fb601 100644 --- a/docs/documentation.md +++ b/docs/documentation.md @@ -7,132 +7,132 @@ description: "A guide for using SpaceVim." -- [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) @@ -969,7 +969,7 @@ after pressing prefix `z` in normal mode, if you do not remember the mappings, y | `zO` | open folds recursively | | `zR` | set `foldlevel` to deepest fold | | `zW` | mark wrong spelled | -| `zX` | re-apply `foldlevel` | +| `zX` | re-apply `foldlevel` | | `z^` | cursor to screen bottom line N | | `za` | toggle a fold | | `zb` | redraw, cursor line at bottom | @@ -1442,7 +1442,7 @@ Unite work flow leader can only be used in normal mode. Unite leader need unite - List all the starred repos in github.com, fuzzy find and open the website of the repo. default key is `ls` ![2017-02-01_1359x722](https://cloud.githubusercontent.com/assets/13142418/22506915/deb99caa-e8bd-11e6-9b80-316281ddb48c.png) -#### Plugin Highlights +### Plugin Highlights - Package management with caching enabled and lazy loading - Project-aware tabs and label @@ -1459,7 +1459,7 @@ Unite work flow leader can only be used in normal mode. Unite leader need unite [lazy-loaded]: ./config/plugins.vim -#### Non Lazy-Loaded Plugins +### Non Lazy-Loaded Plugins | Name | Description | | ---------------- | ----------------------------------------------------- | diff --git a/docs/layers/lang/markdown.md b/docs/layers/lang/markdown.md index f9ddb7af5..6d9e5b698 100644 --- a/docs/layers/lang/markdown.md +++ b/docs/layers/lang/markdown.md @@ -6,11 +6,11 @@ title: "SpaceVim lang#markdown layer" -- [Description](#description) -- [Layer Installation](#layer-installation) -- [formatting](#formatting) - - [options](#options) -- [Key bindings](#key-bindings) +* [Description](#description) +* [Layer Installation](#layer-installation) +* [formatting](#formatting) + * [options](#options) +* [Key bindings](#key-bindings) @@ -44,7 +44,11 @@ How to indent the content from list items (`tab`, `mixed` or 1 , default: 1). **enableWcwidth** -Enable/Disable wcwidth for detecting the length of a table cell, default is 0. +Enable/Disable wcwidth for detecting the length of a table cell, default is 0. To enable this option, you need to install [wcwidth](https://www.npmjs.com/package/wcwidth) + +**listItemChar** + +Bullet marker to use for list items (`'-'`, `'*'`, or `'+'`, default: `'-'`). ## Key bindings