Md2Vim

blackfriday golang markdown md2vim mit license vim

Writing technical documentation for Vim extensions is not exciting; manually converting what you’ve just written in Markdown to vimdoc format is even less fun. I grew tired of having to do this repeatedly for my Vim-ArgWrap extension and finally formally solved this problem with a purpose-built tool. Maintainability, ease of use, and beautiful vimdoc output were primary considerations in Md2Vim’s design.

Markdown source file VimDoc target file

Installation

If you already have the Go environment and toolchain set up, you can get the latest version by running:

$ go get github.com/FooSoft/md2vim

Otherwise, you can use the pre-built binaries for the platforms below:

Usage

Executing Md2Vim with the -help command line argument will trigger online help to be displayed. The list below provides a more detailed description of what the parameters do.