1
0
mirror of https://github.com/SpaceVim/SpaceVim.git synced 2025-01-25 02:20:04 +08:00
SpaceVim/docs/cn/layers/lang/markdown.md
Lin Kun 5f1d96b7cf Remove: Delete format markdown table key binding SPC l ft. (#2613)
* Fixed: the | that prefixed by a \ should not be treated as a seperator of MarkDown table.

* Remove the key binding SPC l ft of Markdown layer.

* Doc: remove the descriptions of SPC l ft which has been removed.
2019-02-20 21:57:51 +08:00

2.2 KiB
Raw Blame History

title description lang
SpaceVim lang#markdown 模块 这一模块为 Markdown 编辑提供支持,包括格式化、自动生成文章目录、代码块等特性。 cn

可用模块 >> lang#markdown

模块简介

这一模块为 SpaceVim 提供 Markdown 编辑支持,包括格式化、实时预览、自动生成 TOC 等特性。

启用模块

可通过在配置文件内加入如下配置来启用该模块:

[[layers]]
  name = "lang#markdown"

代码格式化

SpaceVim 默认使用 remark 来格式化 Markdown 文件Windows 下建议使用 Prettier 来格式化 Markdown 文件。

remark 可通过 npm 命令来安装:

npm -g install remark
npm -g install remark-cli
npm -g install remark-stringify

Prettier 可通过 yarnnpm 命令来安装:

  1. 通过 yarn 命令来安装
yarn global add prettier
  1. 通过 npm 命令来安装
npm install --global prettier

模块设置

listItemIndent

设置有序列表对齐方式 (tab, mixed 或者 1 , 默认: 1)。

  • 'tab': 使用 tab stops 对齐
  • '1': 使用空格对齐
  • 'mixed': use 1 for tight and tab for loose list items

enableWcwidth

启用/禁用表格字符宽度检测,默认未启用该功能。若需要启用该功能,需要额外安装 wcwidth

listItemChar

设置无序列表前缀 ('-', '*', or '+', 默认: '-')。

快捷键

快捷键 模式 按键描述
SPC b f Normal 格式化当前文件
SPC l k Normal 增加链接 URL
SPC l p Normal 通过浏览器实时预览当前文件