---

Ⅰ. 插件描述

Vim plugin for previewing pandoc markdown

Ⅱ. 基本信息

创建日期：  2018-08-29 使用用户：  2 Github星：  8 插件作者：  Conor Newton

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'conornewton/vim-pandoc-markdown-preview'

… 然后在Vim中运行以下命令:

:source %
:PluginInstall

对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'conornewton/vim-pandoc-markdown-preview'

… 然后在Vim中运行以下命令:

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'conornewton/vim-pandoc-markdown-preview'

… 然后在Vim中运行以下命令:

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/conornewton/vim-pandoc-markdown-preview

Ⅳ. 文档说明

# Vim Pandoc Markdown Previewer

Dependencies

• vim
• pandoc

• a pdf viewer:

  • Evince (Works on Mac)
  • Mupdf
  • Okular

many other pdf readers should work, above is a list that I have tested.

For async support (Compiling in background)

• vim version >= 8.00
• asyncrun.vim

Installation

Just like any other vim plugin

Usage

Starting the preview

To start the preview mode:

:StartMdPreview

This will compile your markdown document and open it in one of the above pdf viewers.

If the preview is currently running every save will recompile the document and the previewer will
be refreshed.

To stop the preview mode:

:StopMdPreview

Once the preview is stopped the document won't be automatically compiled when saved.

Choosing a previewer

Stick the following in your vimrc, replacing <previewer> with the name of your preferred pdf viewer.

let g:md_pdf_viewer="<previewer>"

Passing arguments to pandoc

You can make use of the g:md_arg variable to pass arguments to pandoc. For example, taken from my vimrc.

let g:md_args = "--template eisvogel --listings"

This compiles markdown using the eisvogel template.