---

Ⅰ. 插件描述

Vimプラグインのヘルプファイルを自動生成する。さらにヘルプファイルからREADME.mdも生成できる。

Ⅱ. 基本信息

创建日期：  2013-08-06 使用用户：  7 Github星：  12 插件作者：  LeafCage

Ⅲ. 安装方法

使用Vundle管理器安装

在你的.vimrc下添加:

Plugin 'leafcage/vimhelpgenerator'

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

:source %
:PluginInstall

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

使用NeoBundle管理器安装

在你的.vimrc下添加:

NeoBundle 'leafcage/vimhelpgenerator'

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

:source %
:NeoBundleInstall

使用VimPlug管理器安装

在你的.vimrc下添加:

Plug 'leafcage/vimhelpgenerator'

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

:source %
:PlugInstall

使用Pathogen管理器安装

在终端中运行以下命令:

cd ~/.vim/bundle
git clone https://github.com/leafcage/vimhelpgenerator

Ⅳ. 文档说明

# vimhelpgenerator.vim
vimプラグインのヘルプファイルを自動生成する。

概要

vimhelpgenerator はプラグインを構成するファイルからヘルプを自動生成するVimプラグインです。ヘルプファイル作成の負担を減らすために開発されました。プラグインの変数、コマンド、キーマップ、関数を収集して、テンプレートに則って出力します。

最新版:
https://github.com/LeafCage/vimhelpgenerator.vim

使い方

ソースファイルからヘルプファイルを生成する

ヘルプファイルを作成したいプラグインの、いずれかのファイルを開いて:VimHelpGeneratorを実行する。
確認プロンプトが出るので e で実行継続する。
作成後、自動的に作成されたファイルが開かれるので、そのまま編集をする。

ヘルプファイルからREADME.mdを生成する

ヘルプファイル内で、README.mdに含めたい行をビジュアル行選択した後、:HelpIntoMarkdownを実行する。
レジスタに変換結果がセットされ、README.mdが開かれるので任意の場所でputする。