vim为markdown文件写snippets

vim为markdown文件写snippets

vim 中可以为不同的文件类型写snippets(代码片段,用来快速补全一些经常输入的代码或文本),本篇文章通过给markdown文件写snippets来熟悉snippets文件的语法。

snippet 语法简单的介绍

每个snippet片段分为三部分,起始行,片段代码,结束行。

起始行 语法

snippet trigger_word [ "description" [options]]

其中snippet 为关键字 trigger_word 是触发关键字,可以是单词也可以是表达式(含有空格的字符串需要用引号包裹,或使用其他的边界符号),description是该snippet的描述,options是该snippet的属性

snippet 属性
  • b beginning of line 如果代码块中有这个选项,只有在关键字是该行第一个单词的情况下触发。如果在该触发词之前只有空格,也会触发。(不加选项,默认是在任何位置都能触发的。)
  • i in-word expansion 字内扩展 - 默认情况下,片段在该行第一个单词或者前面是一个或多个空格时触发。一个含有此选项snippet,会忽略前面的字母。换句话说,snippet可以在单词中间触发,会忽略前面的字母。
  • w word boundry 使用此选项,片段会在触发关键字匹配特定单词开头边界、和匹配特定单词结束边界时展开。换言之,触发关键字的前面和后面必须是分单词字符。单词字符是有‘iskeyword’设置的。
  • r reggular expression 触发关键字是python正则表达式。必须用引号包裹(或其他字符)
  • t do not expand tabs 忽略片段中的tab字符,默认情况下,代码片段在插入的时候会根据vim现有的关于tab的设置对代码片段中含有的tag字符进行正确的配置。如果含有此选项,snippet会忽略代码中的tab字符,原样添加
  • s 在跳转下一个tab停止位时,删除在行尾处光标前的空白字符。
  • m 删除代码片段右侧的空格
  • e 自定义代码上下文
  • a 代码片段会自动触发
中间片段代码
$visual

在snippet中包含一个特殊的替换字符 ${visual}。用来替换选中的文字。
在观察模式下选中一些文字,按下触发(g:ultisnipsexpandtrigger)键,这时选中的文字会被删除。进入插入模式,输入触发关键字,触发代码模版,这时就能看到选择的文字在里面.

插入代码

中间的代码片段可以支持三种代码类型的编辑

  • shell 代码
  • vim script 也可称为viml
  • python
tabstop

snippets 是用来快速向文档中插入重复使用的文本。一般该文本会由不同的部分组成固定的结构。tabstop(触发中继)用来简化变化部分的修改。通过tabstop你可以很容易的在变化的内容上放置光标,进入内容输入,或者调到下一个输入内容处,直到所有内容输入完成。
tabstop的语法是一个''符后接一个数字,tabstop最开始的数字是1,以此类推。‘0’是一个特殊字符,它总是代表了最后一个tabstop,无论有多少tabstop被定义,如果没有定义‘0’,那么在代码的最后会被定义成'0'

结束行

结束行只有一个 ‘endsnippet’关键字


标题的snippet

markdown标题的语法是‘#‘,数量1-6,代表各标题的等级。我们要实现的目标是:

  • 把选中的文字以标题语法包裹
  • 直接在创建空的标题语法用来写入

实现的代码如下:

snippet sec "section"
# ${1:${visual:标题}} #$0
endsnippet

下面对这段代码作详细的说明:

这是一级标题的snippet,如果有选中内容就把选中的内容放到两个‘#’之间(没有选中则有默认值标题),因为tabstop$1的关系,内容会被置为选中状态,这时标题内容可以被编辑。再次按下tab键。光标会跳转到#后。

代码块snippet

markdown 的语法是``````,如果在第三个反引号的后面加上代码块使用的语言可以让编辑器增加语法高亮方便阅读,如html、javascript等,下面来通过书写一个正则匹配的snippet。

要实现输入cd,生成代码块,cd + (js/html/css)来让代码块后面标识上javascript html css的语言标识,我们需要写一个匹配这种情况的正则,cd(\w+)?。然后通过写一小段python代码获得匹配的结果,通过判断匹配的词来写入语言。


snippet "cd(\w+)?" "codeblock with lan" br
\`\`\``!p
if match.group(1) == "html":
    snip.rv="html"
elif match.group(1) == "css":
    snip.rv="css"
elif match.group(1) == "js":
    snip.rv="javascript"
`
$1
\`\`\`
$0
endsnippet

反引号``,后接!p说明是python语句,在python代码块中 match是有正则的情况下的匹配结果。snip.rv 赋值就是返回该代码块的结果(根据cd后面的单词判断并输出代码块的语言)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,254评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,875评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,682评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,896评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,015评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,152评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,208评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,962评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,388评论 1 304
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,700评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,867评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,551评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,186评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,901评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,142评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,689评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,757评论 2 351

推荐阅读更多精彩内容

  • Snippets vim 使用 Snippets 就是一些代码模板,能用通过输入特定的关键词和热键(一般设定为T...
    pipu阅读 6,256评论 0 3
  • 常用的文本编辑器:Sublime Text、Notepad++、EditPlus等 常用的IDE:WebStorm...
    我的程序人生阅读 2,581评论 0 0
  • 摘要 程序员总是会不断的重复写一些简单的代码片段,为了提高编码效率,我们可以把经常用到的代码保存起来再调用。 平时...
    easyblue阅读 3,506评论 3 6
  • HTML 5 HTML5概述 因特网上的信息是以网页的形式展示给用户的,因此网页是网络信息传递的载体。网页文件是用...
    阿啊阿吖丁阅读 3,875评论 0 0
  • 昨天下午四点多先生发信息说晚上有饭局,不回家吃饭了。我看到信息时没理他,其实脑子里已经开始各种编织,喝酒喝得酩酊大...
    铜豌豆candy阅读 660评论 0 0