~puer-robustus/fathub

fathub static site generator
ci: diff to origin/master silently
360b2459 — Mateusz Halada 2 months ago
add dotted bottom line between ingredients on desktop
1a7c1b44 — Mateusz Halada 2 months ago
add filter separator

refs

master
browse  log 

clone

read-only
https://git.sr.ht/~puer-robustus/fathub
read/write
git@git.sr.ht:~puer-robustus/fathub

You can also use your local clone with git send-email.

#Fathub static site generator

This is the code for generating a static recipe website from plain-text recipe files in a specific format.

The static site generator was originally developed for https://fathub.org/. Since the development of the original project seems to have seized, this is a slightly improved version of the original generator.

The recipes themselves are not part of the fathub static site generator - instead they are split off to make it easier to run a fathub instance with your own data, or use the data with a different frontend e.g. a native application.

#Installation & development

# 1. get the site genarator source code:
$ git clone https://git.sr.ht/~puer-robustus/fathub
# 2. clone the recipe files to fathub/dataset:
$ cd fathub
$ git clone https://git.sr.ht/~puer-robustus/fathub-data dataset
# 3. create a venv, activate it, and install the dependencies:
$ python3 -m venv venv
$ source venv/bin/activate
$ python3 -m pip install -r requirements_build.txt
# 4. if you want to aid the development, also install the
# the development requirements ...
$ python3 -m pip install -r requirements_dev.txt
# ... and install the configured pre-commit hooks:
$ pre-commit install --install-hooks
# 5. build the static html files locally:
$ ./build.sh
# 6. you can now serve the website on localhost:8000 with:
$ cd public_html && python3 -m http.server

If you find a bug, would like to request/propose a feature, or would like to add a recipe, please send a mail/patch to this mailing list.

#Recipe data structure

The format for the recipes and the ingredient info pages is documented in the README of the data repository.