How to use¶

May I ask why you are wondering how to build my website...?

Anyways, in case you decide to copy and use my tools directory (in which case, plsz credit):

1. (optional but recommended) Create a venv (location doesn't matter, but the .gitignore assumes .venv in the project root)
2. Install the following python packages: markdown feedgen

3. gen.py and serve_dev.sh assume to be ran in the project root and have adequate permissions. The other scripts should not have to be ran manually, they will be ran when needed.

4. to automatically serve a local python http server for development purposes, use bash tools/serve_dev.sh.

   • this will use inotifywait and automatically (re)generate the html output when any files in the content/ and html/ directories get modified
5. to manually generate the html output (for example when ready to serve in prod), use python3 tools/gen.py.

My workflow should give an example for this:

1. cd to project root
2. open code editor in background, and run serve_dev.sh
3. point browser to http://localhost:8000/ for previewing
4. edit files until happy
5. refresh page, check if everything correct
   • if not, go to step 4
6. commit and push
7. ssh to server
8. git pull && python3 tools/gen.py

My caddy instance serves the out/ directory directly.