在 Vim 中写 Markdown 文件

Posted on 2015-02-01 13:46 in Tools

记录一下最近在 Vim 中摸索使用 Markdown 的经历。

Syntax Hightlight

Vim 可以通过插件来提供对 Markdown 语法的支持,网上找到很多这类插件,我找到的是下面这个 preservim/vim-markdown

Install

使用 Vundle 管理插件,只需要在 .vimrc 文件中添加:

1
2
Plugin 'godlygeek/tabular'
Plugin 'preservim/vim-markdown'

然后输入命令即可。

1
vim +PluginInstall

File extension

Markdown 文件的后缀名可以是 .markdownmkdmkdnmd 等,但是插件只识别 mkdmarkdown 两种:

Enabling markdown highlighting in Vim

因为我们已经按照 .md 格式写了很多文本了,这时候更好选择当然是修改设置,让 vim 可以识别这种类型的文件,而不是修改文件后缀名。所以我们需要在 vimrc 中设置一下:

1
au BufRead,BufNewFile *.md set filetype=markdown

这样 .md 文件就可以被识别了。

经过上面两步,此时再打开 markdown 文件就可以看到语法高亮了。

Preview

一些专门的 Markdown 软件、网页编辑器都是提供实时预览,Vim 虽然不提供预览窗口,但是配合浏览器,我们也可以实现实时预览的功能,当然还是依靠万能的插件。我使用的是 iamcco/vim-preview.nvim

Install

  1. 使用 Vundle 管理插件

    在 .vimrc 中添加

    1
    Plugin 'iamcco/vim-markdown-preview'
    

    打开 vim,输入命令

    1
    2
    :PluginInstall
    :call mkdp#util#install()
    

Use

# start preview
:MarkdownPreview
# stop preview
:MarkdownPreviewStop

Ref

preservim/vim-markdown

Enabling markdown highlighting in Vim

iamcco/markdown-preview.nvim