This is the code behind the https://vimhelp.org website. It runs on Google App Engine.
To make testing and deploying easier, common project tasks are defined in
justfile for use with just. Run just --list
to see the available recipes.
Run just run, then open http://localhost:8000/ for Vim or
http://neo.localhost:8000/ for Neovim. Both sites use the same routes;
the hostname selects the documentation project.
To generate static HTML pages instead of running on Google App Engine:
- Make sure you have uv.
- Run the following from the repository root (replace the
-iparameter with the Vim documentation location on your computer):uv creates or updates the project environment automatically. The script offers a few options; run withscripts/h2h.py -i /usr/share/vim/vim92/doc/ -o html/-hto see what is available.
This code is made freely available under the MIT License (see file LICENSE).