Heyho! Hier liegt der Code für die "Rezeptbuch" Webseite von OlGe404 (https://olge404.github.io).
Um neue Rezepte hinzufügen, müssen diese in dem recipes Ordner als .md Datei hinterlegt und committet werden. Wer nicht auf den "main" Branch committen darf, kann stattdessen einen Pull Request für seine Änderungen erstellen.
Als Vorlage für neue Rezepte soll die Template Datei benutzt werden. Es ist wichtig dass die Formatierung und Syntax aus dem Template übernommen werden, weil der Bau der Webseite sonst fehlschlagen kann. Das ist zwar kein Beinbruch, verhindert bis zur Fehlerbehebung aber das automatische Aktualisieren der Webseite.
Die Webseite ist mit jekyll und dem just-the-docs Theme erstellt worden. Sie wird aus den Dateien in diesem Repo gebaut und das Ergebnis wird auf GitHub Pages gehostet.
Bei Commit auf den "main" Branch wird die Webseite über GitHub Actions automatisch gebaut und deployed, sodass Änderungen in unter 1 Minute live sind.
Um an der Webseite lokal weiterzuentwickeln, wird die ruby version benötigt, die in dem ruby-version file aufgeführt ist. Diese wird auch durch GitHub Actions beim Bau der Webseite benutzt. Zusätzlich müssen die Voraussetzungen für jekyll erfüllt sein. Anschließend kann das Repo lokal geklont und der Webserver mit
makegestartet werden.
Die Änderungen am Code werden live im Browser aktualisiert, sofern die _config.yml Datei nicht bearbeitet wurde. Bei Änderungen an der _config.yml Datei muss der Webserver neugestartet werden.
🤓 Abkürzung: Die Webseite kann auch mit diesem vscode.dev Link im Browser geöffnet und bearbeitet werden. Für das Starten des lokalen Webservers mit der Entwicklungsumgebung im Browser kann GitHub Codespaces genutzt werden.