xaizek / vimdoc2html (License: GPLv3+) (since 2018-12-07)
Converts Vim-style documentation into HTML.
Clone URLs: https://code.reversed.top/user/xaizek/vimdoc2html ssh://rocketgit@code.reversed.top/user/xaizek/vimdoc2html
master
Commit 01be6b06559fec964607dd815a7b0292a2b6a374

Explain high-level operation in the README.md
Author: xaizek
Author date (UTC): 2025-04-16 13:46
Committer name: xaizek
Committer date (UTC): 2025-04-16 13:46
Parent(s): 770559b8de660ba0762c1da6c706c89c1bbb89ef
Signing key: 99DC5E4DB05F6BE2
Tree: 0c965b7e99f0a155bb549a36c2ec2f513d5241f4
File Lines added Lines deleted
README.md 7 0
File README.md changed (mode: 100644) (index 0c87787..70922d7)
... ... or if the script is somewhere in the `$PATH`:
21 21 vimdoc2html.py plugin.txt vimdoc2html.py plugin.txt
22 22 ``` ```
23 23
24 #### Operation ####
25
26 As a first step, `helpztags` script is used to generate `tags` file similar to
27 what Vim's `:helptags` command produces. This is needed to know which
28 references should be turned into hyperlinks. Then the tags and documentation
29 in Vim's format are processed to produce HTML output.
30
24 31 #### Options #### #### Options ####
25 32
26 33 ##### `-o,--output path` option ##### `-o,--output path` option
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