https://github.com/xaizek/vimdoc2html

Converts Vim-style documentation into HTML
https://github.com/xaizek/vimdoc2html

conversion converter html vimdoc

Last synced: about 1 month ago
JSON representation

Converts Vim-style documentation into HTML

• Host: GitHub
• URL: https://github.com/xaizek/vimdoc2html
• Owner: xaizek
• License: gpl-3.0
• Created: 2016-01-12T19:15:14.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T11:44:06.000Z (7 months ago)
• Last Synced: 2024-04-05T12:38:55.440Z (7 months ago)
• Topics: conversion, converter, html, vimdoc
• Language: Python
• Homepage: https://reversed.top/2016-01-13/converting-vim-doc-to-html/
• Size: 45.9 KB
• Stars: 8
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
### Overview ###

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

### Dependencies ###

* Perl

* Python

### Description ###

The basic usage is:

```bash

./vimdoc2html.py plugin.txt

```

or if the script is somewhere in the `$PATH`:

```bash

vimdoc2html.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](https://github.com/c4rlo/vimhelp/blob/master/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](https://github.com/c4rlo/vimhelp/blob/master/static/vimhelp.css).

Tags are extracted via `helpztags` tool written by Jakub Turski

 and Artur R. Czechowski .  It's

supplied alongside for convenience and to provide a couple of changes, see

there.