This week I’ve published a project for building Vim plugin documentation files. Check the documentation for detailed getting started and usage instructions, the source code is available on GitHub. What follows is the TLDR for installation and usage…

Clone

mkdir -vp ~/git/hub/vim-utilities

cd ~/git/hub/vim-utilities

git clone git@github.com:vim-utilities/build-vim-doc.git

Install

cd ~/git/hub/vim-utilities/build-vim-doc

make install

Usage

Make a directory for Vim new documentation file…

mkdir -p ~/git/hub/vim-utilities/project-name/doc

Run build-vim-doc script to initialize a new documentation file…

build-vim-doc --path ~/git/hub/vim-utilities/project-name\
              --name script-file.vim\
              --mode Visual
              --author S0AndS0\
              --version 8.2