Gaze/SpaceVim
1
0
Fork 0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-04-14 23:49:19 +08:00
Code Issues Projects Releases Wiki Activity

docs(lang#markdown): update :h SpaceVim-layers-lang-markdown

Browse Source
This commit is contained in:
Shidong Wang 2021-10-10 23:48:17 +08:00
parent d85912c15a
commit 26baf7c2e4
No known key found for this signature in database
GPG Key ID: 41BB7053E835C848
2 changed files with 50 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
autoload/SpaceVim/layers/lang/markdown.vim
View File

@ -9,21 +9,43 @@
""
" @section lang#markdown, layers-lang-markdown
" @parentsection layers
" This layer is for markdown language, disabled by default, to enable this
" layer, add following snippet to your SpaceVim configuration file.
" This layer adds markdown support to SpaceVim. It is disabled by default,
" to enable this layer, add following snippet to your SpaceVim configuration
" file.
" >
" [[layers]]
" name = 'lang#markdown'
" <
" @subsection Layer options
"
" 1. `enabled_formater`: Set the enabled formater, by default it is
" `['remark']`.
" The following layer options are supported in this layer:
"
" 1. `enabled_formater`: Set the enabled formater, by default it is
" `['remark']`. To use `prettier`, you need to install `prettier` via:
" >
" npm install --global prettier
" <
" 2. `enableWcwidth`: Enable/disabled wcwidth option, it is disabled by
" default.
" 3. `listItemChar`: Set the default list item char, it is `-` by default.
" 4. `listItemIndent`: Set the default indent of list item. It is `1` by
" default.
" Here is an example for loading `lang#markdown` layer:
" >
" [[layers]]
" name = 'lang#markdown'
" enableWcwidth = 1
" listItemIndent = 1
" enabled_formater = ['prettier']
" <
" @subsection key bindings
"
" This layer brings following key bindings to markdown file:
" >
" Key binding Description
" Ctrl-b insert code block
" SPC l r run code in code block
" <
if exists('s:md_listItemIndent')
finish

27
doc/SpaceVim.txt
View File

@ -3159,21 +3159,42 @@ This layer also provides REPL support for lua, the key bindings are:
==============================================================================
LANG#MARKDOWN *SpaceVim-layers-lang-markdown*
This layer is for markdown language, disabled by default, to enable this
layer, add following snippet to your SpaceVim configuration file.
This layer adds markdown support to SpaceVim. It is disabled by default, to
enable this layer, add following snippet to your SpaceVim configuration file.
>
[[layers]]
name = 'lang#markdown'
<
LAYER OPTIONS
The following layer options are supported in this layer:
1. `enabled_formater`: Set the enabled formater, by default it is
`['remark']`.
`['remark']`. To use `prettier`, you need to install `prettier` via:
>
npm install --global prettier
<
2. `enableWcwidth`: Enable/disabled wcwidth option, it is disabled by
default.
3. `listItemChar`: Set the default list item char, it is `-` by default.
4. `listItemIndent`: Set the default indent of list item. It is `1` by
default.
Here is an example for loading `lang#markdown` layer:
>
[[layers]]
name = 'lang#markdown'
enableWcwidth = 1
listItemIndent = 1
enabled_formater = ['prettier']
<
KEY BINDINGS
This layer brings following key bindings to markdown file:
>
Key binding Description
Ctrl-b insert code block
SPC l r run code in code block
<
==============================================================================
LANG#MOONSCRIPT *SpaceVim-layers-lang-moonscript*