Emacs Markdown Mode 入门之github风格的markdown

英文原文

github风格markdown(GFM)

github风格markdown模式也叫gfm模式.github实现的markdown与标准的markdown略有不同,它支持诸如单词中使用下划线,自动链接URL,删除线文本以及使用可选语言关键字标记的代码块等不同行为.
上述GFM才有的特征常应用于github仓库中的README.md文件,wiki页面,和其他markdown格式的文件.github也支持一些额外的特征以帮助在网页上书写markdown，例如在github中书写issues,pull requests,messages等。这些特征还包括任务列表(复选框),对应于硬换行的新行,自动链接到issues和commits的引用,wiki链接等等.尽管任务列表作为GFM的一部分并不合适,它使事情变得更复杂,但是自从2014年它们在网站的软件仓库的所有的markdown文档中被提供.下面来介绍gfm模式与markdown模式下相关的扩展内容.

URL自动链接

markdown模式和gfm模式都支持高亮显示没有尖括号标记的URL字符串.

单词中的多下划线

必须使能gfm模式下的支持单词中间的下划线功能开关,在这种模式下,例如a_test_variable这样的变量名将不会被解释为斜体.

围住的代码块

用反引号标记的代码块可以加入可选的编程语言关键字并且在markdown模式和gfm模式下高亮显示.使用C-c C-s P可以插入这样的代码块.如果有活动区域,区域中的文本将会移动到代码块中,同时你将被要求输入语言的名字,但可以直接输入回车跳过输入.

删除线

删除文本仅在gfm模式下被支持,可是使用C-c C-s d插入.向其他命令绑定关系的助记词一样,d与HTML中的标签< del >对应.

任务列表

GFM的任务列表在markdown-make-gfm-checkboxes-buttons被设置为非空值时(默认设为t)以emacs复选框按钮形式在markdown模式和gfm模式下提供.鼠标点击,在按钮上按下RET或者光标位于复选框的某处时使用C-c C-x C-x可以激活复选框.

wiki链接

makrdown模式支持一般的wiki链接,但是在gfm模式像在github上一样对待这些链接:文件名中的空格将被连字符代替并且第一个字符大写.例如[[wiki link]]将映射到文件名为Wiki-link具有当前文件相同后缀的文件上.如果当前目录不存在这样的文件,会使用子目录中第一个匹配的文件.

新行

markdown模式和gfm模式都不会针对新建一行的行为做些什么.如果你总是使用gfm模式在github上写comment或者issue,新建一行非常重要并且和硬分行相当,那么你会为buffer中的行使能visual-line-mode.你可以像这样使用gfm-mode-hook来达到目的:

;; Use visual-line-mode in gfm-mode(defun my-gfm-mode-hook ()  (visual-line-mode 1))(add-hook 'gfm-mode-hook 'my-gfm-mode-hook)Preview: GFM-specific preview can be powered by setting markdown-command to use Docter. This may also be configured to work with Marked 2 for markdown-open-command.