vimhelpgenerator.vim

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

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

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

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

LeafCage/vimhelpgenerator