Converts Vim-style documentation into HTML
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
COPYING
README.md
helpztags
vimd2h.py
vimdoc2html.py
vimhelp.css

README.md

Overview

This is a script to convert Vim documentation file into HTML.

Dependencies

  • Perl
  • Python

Description

The basic usage is:

./vimh2h.py plugin.txt

or if the script is somewhere in the $PATH:

vimh2h.py plugin.txt

The only "advanced" usage is currently enabled by -r or --raw flag, in which case instead of outputting complete standalone HTML page only minimal output is produced. This way after customizing style/template only the contents can be replaced.

Credit

HTML formatting is performed via modified version of vimh2h.py by Carlo Teubner <(first name) dot (last name) at gmail dot com>. This one is simplified to remove unused here code and a bit improved to add anchors to each tag definition. CSS style is from there too.

Tags are extracted via helpztags tool written by Jakub Turski yacoob@chruptak.plukwa.net and Artur R. Czechowski arturcz@hell.pl. It's supplied alongside for convenience and to provide a couple of changes, see there.