/vimhelp

Google App Engine based project which regularly generates HTML versions of the Vim help files

Primary LanguagePythonMIT LicenseMIT

vimhelp.org

This is the code behind the https://vimhelp.org website. It runs on Google App Engine.

To make testing and deploying easier, a tasks.py file exists for use with the Invoke 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).