Table of Contents

Markdown Layer

本文章基于Markdown Layer README适当润色翻译为简体中文,Markdown Layer README官方链接见下.

Markdown Layer是Spacemacs之中用来处理/编辑Markdown文档的组件,它的GitHub地址是:

安装

如果你想使用Spacemacs的Markdown Layer,你只需要在你的.spacemacs配置文件中的dotspacemacs-configuration-layers列表之中加入markdown即可,就像下面这样:

dotspacemacs-configuration-layers  
                                '(
                                  markdown
                                  )

即时预览

Markdown-Mode默认情况下就可以使用Emacs的内置游览器来对Markdown文档进行实时预览.虽然方便,但是显示效果不尽人意.

不过不用担心,我们可以通过外部的vmd引擎来获得更好的体验效果.vmd使用NodeJS编写,它的GitHub地址是:

如果要使用vmd作为Spacemacs的Markdown外部实时预览引擎,我们需要使用NodeJS的包管理器npm来安装vmd:

如果你没有NodeJS

Windows Install NodeJS and NPM

  • 如果你没有安装过NodeJS,需要先前往它的首页下载安装包,之后在进行下一步:

Ubuntu Install NodeJS and NPM

  • 一条命令安装NodeJS:
    • $apt install nodejs npm

macOS Install NodeJS and NPM

  • macOS推荐使用Homebrew来进行安装.
  • macOS使用Homebrew安装NodeJS只需一条命令$brew install nodejs

NodeJS安装完成之后你可以在终端使用$node -v$npm -v命令来验证安装是否正确,如果安装正确终端就会打印出版本号我的显示可能与你不同:

$node -v
v6.10.1  
$npm -v
3.10.10  

如果你有NodeJS

  • 如果你已安装完成NodeJS,只需要开启CMD,执行一条命令即可自动安装vmd:
    • $npm install -g vmd
  • 安装完成之后,需要在终端输入命令$vmd --version,如果终端刷新打印出版本号我的显示可能与你不同,即代表vmd安装成功了:
$vmd --version
1.29.0  

在Spacemacs中配置vmd

  • 接着你还需要在你的.spacemacs配置文件中的dotspacemacs-configuration-layers列表之中加入(markdown :variables markdown-live-preview-engine 'vmd)来启用它,就像下面这样:
dotspacemacs-configuration-layers  
                                '(
                                  markdown
                                  (markdown :variables markdown-live-preview-engine 'vmd)
                                  )

在Spacemacs中使用vmd

之后你就可以在使用Spacemacs编辑Markdown文件的时候,使用快捷键, c P就可以调出vmd来进行实时预览了.或者你也可以使用命令vmd-mode来调出它.

使用

生成TOC

生成当前Markdown内容类型表,使用命令:markdown-toc-generate-toc

快捷键

  • 插入元素

  • 移除元素

  • 完成

  • 跳跃

  • 缩进

  • 标题导航

  • 缓冲区命令

  • 列表编辑

  • 移动

  • 降级升级