---

Ⅰ. 插件描述

Generate ctags-compatible tags files for Markdown documents.

Ⅱ. 基本信息

创建日期：  2013-11-27 使用用户：  33 Github星：  95 插件作者：  John Szakmeister

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'jszakmeister/markdown2ctags'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'jszakmeister/markdown2ctags'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'jszakmeister/markdown2ctags'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/jszakmeister/markdown2ctags

Ⅳ. 文档说明

markdown2ctags

---

This application generates ctags-compatible output for the sections of a
Markdown document.

The motivation was to have a tool fast enough to use with the
TagBar <https://github.com/majutsushi/tagbar>_ plugin in Vim.

Using with TagBar

To use this tool with TagBar, add the following into your ~/.vimrc::

" Add support for markdown files in tagbar.
let g:tagbar_type_markdown = {
    \ 'ctagstype': 'markdown',
    \ 'ctagsbin' : '/path/to/markdown2ctags.py',
    \ 'ctagsargs' : '-f - --sort=yes --sro=»',
    \ 'kinds' : [
        \ 's:sections',
        \ 'i:images'
    \ ],
    \ 'sro' : '»',
    \ 'kind2scope' : {
        \ 's' : 'section',
    \ },
    \ 'sort': 0,
\ }

.. note::

The suggested ``sro`` used to be ``|``, but this symbol could be used in
headings (when talking about logical operators, for example).  As a result,
I recommend using something like the UTF-8 chevron above and specifying this
new sro character on the command line via the ``--sro`` option.

However, some folks have had issues with the chevron--TagBar is failing to
split on the character correctly and it results in incorrect headings that
contain ``<bb>`` in TagBar.  I'm not sure what the underlying cause is just
yet, but if you're suffering from this issue, you may want to fall back to
using the ``|`` character.  You can do this by dropping the ``--sro=»``
parameter from ``ctagsargs`` and setting ``'sro'`` to ``'|'``.

You'll need to have the TagBar plugin installed for this to work. Also, you
may need to call the variable g:tagbar_type_mkd and change ctagstype to
'mkd' if you're Ben William's Markdown syntax highlighting script. It sets
the file type to mkd whereas Tim Pope's sets it to markdown.

License

This tool is licensed under a Simplified BSD license. See LICENSE.txt for
details.