https://github.com/c4rlo/vimhelp
Google App Engine based project which regularly generates HTML versions of the Vim help files
https://github.com/c4rlo/vimhelp
vim
Last synced: 3 months ago
JSON representation
Google App Engine based project which regularly generates HTML versions of the Vim help files
- Host: GitHub
- URL: https://github.com/c4rlo/vimhelp
- Owner: c4rlo
- License: mit
- Created: 2010-10-11T22:00:10.000Z (over 15 years ago)
- Default Branch: master
- Last Pushed: 2026-02-07T11:15:19.000Z (4 months ago)
- Last Synced: 2026-03-05T04:11:08.317Z (4 months ago)
- Topics: vim
- Language: Python
- Homepage: https://vimhelp.org
- Size: 2.15 MB
- Stars: 88
- Watchers: 5
- Forks: 11
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# vimhelp.org
This is the code behind the https://vimhelp.org website. It runs on
[Google App Engine](https://cloud.google.com/appengine/).
To make testing and deploying easier, a `tasks.py` file exists for use
with the [_Invoke_](https://www.pyinvoke.org/) tool (which is similar in
spirit to _Make_).
## Generating static pages
To generate static HTML pages instead of running on Google App Engine:
- Create a virtualenv. If you have _Invoke_ installed, this is as easy as
`inv venv`. Alternatively:
```
python3 -m venv --upgrade-deps .venv
.venv/bin/pip install -r requirements.txt
```
- Run the following (replace the `-i` parameter with the Vim documentation
location on your computer):
```
scripts/h2h.py -i /usr/share/vim/vim90/doc/ -o html/
```
The script offers a few options; run with `-h` to see what is available.
## License
This code is made freely available under the MIT License (see file LICENSE).