google / vimdoc

Helpfile generation for vim
Apache License 2.0
291 stars 28 forks source link

[Maktaba integration] vimdoc should document plugin[*] flags #16

Closed Soares closed 10 years ago

Soares commented 10 years ago

For a user that just installs a given maktaba plugin and hasn't studied the intricacies of maktaba, it takes some sleuthing to figure out that a given plugin can be configured using maktaba's standard plugin[autocmds], plugin[mappings], etc.

vimdoc should automatically detect the standard maktaba plugin/.vim and instant/.vim files and generate flag documentation for relevant flags in each plugin's docs. We can even detect exactly which files exist with the maktaba#plugin#Enter prelude and generate exactly the right keys.

Note that plugins may define their own vimdoc or default values for plugin[*] and instant[*] flags, and we'd need to make sure not to clash with those.