---

Ⅰ. 插件描述

pandoc integration and utilities for vim

Ⅱ. 基本信息

创建日期：  2011-09-05 使用用户：  918 Github星：  584 插件作者：  David Sanson

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'vim-pandoc/vim-pandoc'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'vim-pandoc/vim-pandoc'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'vim-pandoc/vim-pandoc'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

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

Ⅳ. 文档说明

# vim-pandoc

vim-pandoc provides facilities to integrate Vim with the [pandoc][] document
converter and work with documents written in [its markdown
variant](http://johnmacfarlane.net/pandoc/README.html#pandocs-markdown)
(although textile documents are also supported).

vim-pandoc's goals are 1) to provide advanced integration with pandoc, 2) a
comfortable document writing environment, and 3) great configurability.

IMPORTANT

• vim-pandoc doesn't provide syntax support. The user needs to install
  [vim-pandoc/vim-pandoc-syntax][] alongside it (see below). The reason for

this is we have found cleaner to keep the bug tracking of the syntax file and
the rest of the system separate.

Outstanding features

• [x] Modular architecture, so the user is in control of what the plugin does.
  For example, if you decide you don't want to use our folding rules, you can

disable them without it affecting other parts of vim-pandoc. Modules are
simple to develop, too.

• [x] Sets up a comfortable environment for editing prose, either for soft or
  hard wraps.
• [x] Can execute pandoc asynchronously, through the :Pandoc command, which
  can accept any argument pandoc takes, both in regular vim and in

neovim.

• [x] pandoc is a filetype plugin, but it can also attach itself to
  different filetypes, like textile or restructuredText. The user is not

limited to use pandoc with markdown.

• [x] Useful custom mappings for markdown writers (partially implemented,
  perpetually ongoing). For example, we provide WYSIWYG-style style toggles for

emphasis, strong text, subscripts, etc. [Suggestions are
welcome.](https://github.com/vim-pandoc/vim-pandoc/issues/2)

• [x] Advanced folding support (syntax assisted, relative ordering...).
• [x] TOC functionality, using vim's quickfix system.
• [x] Bibliographies support, like autocompletion of cite keys. We plan to
  display additional information on the bibliography items on request.
• [x] Basic hypertext support: follow internal and external links.
• [ ] Annotations: add metadata to your files (comments, TODOs, etc.)

Requirements

• Vim 7.4/Neovim (we make use of the new python API).
• Python 3
• Pandoc 2.x

Installation

The plugin follows the usual bundle structure, so it's easy to install it using
pathogen,
Vundle or NeoBundle.

The most recent version is available [at
github](https://github.com/vim-pandoc/vim-pandoc). For those who need it, a
tarball is available from
here.

For Vundle users, it should be enough to add

Plugin 'vim-pandoc/vim-pandoc'

to .vimrc, and then run :PluginInstall.

It is very strongly recommended that all users of vim-pandoc install
vim-pandoc-syntax too:

Plugin 'vim-pandoc/vim-pandoc-syntax' 

Contributing

fmoralesc is the project maintainer, and he tries
to solve all issues as soon as possible. Help is very much appreciated, in the
form of bug reports, fixes, code and suggestions.

If you have a problem, it is better to open a issue in the [issue tracker at
github][]. Please state the problem clearly, and if possible, provide a
document sample to reproduce it.

Join the chat at https://gitter.im/vim-pandoc/vim-pandoc