---

Ⅰ. 插件描述

A lint tool for vim help files.

Ⅱ. 基本信息

创建日期：  2016-02-12 使用用户：  5 Github星：  26 插件作者：  machakann

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'machakann/vim-vimhelplint'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'machakann/vim-vimhelplint'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'machakann/vim-vimhelplint'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

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

Ⅳ. 文档说明

# vim-vimhelplint

How to use

1. Install vim-vimhelplint

   • Copy ftplugin/help_lint.vim to your ~/.vim/ftplugin/help_lint.vim.

   • Or you can use your favorite plugin manager (Vundle, Neobundle, vim-plug).

     " Vundle
     Plugin 'machakann/vim-vimhelplint'
     
     " Neobundle
     NeoBundle 'machakann/vim-vimhelplint'
     
     " vim-plug
     Plug 'machakann/vim-vimhelplint'

2. Open Vim and edit your help file: :edit path/to/your_help_file.txt
3. Execute the ex command :VimhelpLint, and it will report errors to the
   quickfix list. You can use e.g. :copen to open the list then.

Use :VimhelpLint! to open the quickfix window automatically.

---

Or if you are using Neomake, run the shell command in the root directory of Neomake plugin.

make build/vimhelplint

Then it automatically downloads vimhelplint, you can run it by:

:Neomake vimhelplint

Integration in CI

You can run the plugin automatically as follows, e.g. on Travis CI:

vim -esN --cmd 'set rtp+=path/to/vim-vimhelplint' -c 'filetype plugin on' \
    -c 'e doc/yourplugin.txt' -c 'verb VimhelpLintEcho' -c q