Skip to content

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

Notifications You must be signed in to change notification settings

LeafCage/vimhelpgenerator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vimhelpgenerator.vim

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

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

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

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

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

About

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

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published