File Mode Size
.gitignore 100644 13B
COPYING 100644 34KiB
README.md 100644 1,163B
helpztags 100755 2,278B
vimd2h.py 100755 7,024B
vimdoc2html.py 100755 2,435B
vimhelp.css 100644 1,258B

/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.

Hints

Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://code.reversed.top/user/xaizek/vimdoc2html

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@code.reversed.top/user/xaizek/vimdoc2html

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a pull request:
... clone the repository ...
... make some changes and some commits ...
git push origin master