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.

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.

Screenshots

Markdown source file VimDoc destination file

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.