This is kind of two questions in one. Lately I've been spending a lot of time learning vimscript in-depth, learning vim's internals & taking my first steps writing vim plugins. During this process, I've been keeping extensive notes in individual markdown files & add lots of inline 'documentation' comments to the vimscript files.
I feel like I've finally got some code that's worth sharing, and want to start adding some actual documentation. I haven't authored any of my own helpdoc files yet, so I'm still figuring out that process.
Without any experience yet or solid understanding of this workflow, there are two tasks I'm trying to figure out:
- Generating helpdoc files from my markdown 'notes' files on vim/vimscript, so I can read/reference quickly & easily from vim at any time.
- Parsing the inline documentation from my vimscript files (similar to the way shocco works for shell scripts) to generate the associated helpdoc for the vimscripts.
Any suggestions or advice on the ideas (this is a bad idea because ..., a better idea is ...), or how to accomplish them would be greatly appreciated.