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 770559b8de660ba0762c1da6c706c89c1bbb89ef

Make README.md up-to-date with options
Author: xaizek
Author date (UTC): 2025-04-16 13:08
Committer name: xaizek
Committer date (UTC): 2025-04-16 13:10
Parent(s): f38dd46b11a5d03ebee1d5d248e14397fb39e080
Signing key: 99DC5E4DB05F6BE2
Tree: 9b73afcd0c0319b85ffc5341c4c09d82b737e0ec
File Lines added Lines deleted
README.md 33 4
File README.md changed (mode: 100644) (index a0ba0d9..0c87787)
... ... or if the script is somewhere in the `$PATH`:
21 21 vimdoc2html.py plugin.txt vimdoc2html.py plugin.txt
22 22 ``` ```
23 23
24 The only "advanced" usage is currently enabled by `-r` or `--raw` flag, in which
25 case instead of outputting complete standalone HTML page only minimal output is
26 produced. This way after customizing style/template only the contents can be
27 replaced.
24 #### Options ####
25
26 ##### `-o,--output path` option
27
28 Specifies name of the output file. The default behaviour is to derive it from
29 the name of the input file by appending `.html`.
30
31 ##### `-r,--raw` flag
32
33 Instead of outputting complete standalone HTML page, produce only minimal
34 output without `<html>`/`<head>`/`<body>`/`<pre>` tags.
35
36 ##### `-t,--template path` option
37
38 Overrides builtin template. The following sequences will be expanded:
39 - `{title}` with the name of the source file
40 - `{style}` with the contents of `vimhelp.css`
41 - `{html}` with documentation formatted as HTML
42
43 Default template is trivial:
44 ```html
45 <html>
46 <head>
47 <title>{title}</title>
48 <style>{style}</style>
49 </head>
50 <body>
51 <pre>
52 {html}
53 </pre>
54 </body>
55 </html>
56 ```
28 57
29 58 ### Credit ### ### Credit ###
30 59
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