https://github.com/olge404/olge404.github.io

Heyho! Hier liegt der Code für die "Rezeptbuch" Webseite von OlGe404.
https://github.com/olge404/olge404.github.io

Last synced: about 2 months ago
JSON representation

Heyho! Hier liegt der Code für die "Rezeptbuch" Webseite von OlGe404.

• Host: GitHub
• URL: https://github.com/olge404/olge404.github.io
• Owner: OlGe404
• License: apache-2.0
• Created: 2024-01-22T12:51:35.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-16T20:17:41.000Z (about 2 months ago)
• Last Synced: 2024-11-16T21:22:37.949Z (about 2 months ago)
• Language: HTML
• Homepage: https://olge404.github.io/
• Size: 438 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Rezeptbuch

Heyho! Hier liegt der Code für die "Rezeptbuch" Webseite von OlGe404 (https://olge404.github.io).

# Hinzufügen neuer Rezepte

Um neue Rezepte hinzufügen, müssen diese in dem [recipes Ordner](content/recipes) 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](content/recipes/_template.md) 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.

## Technische Details

Die Webseite ist mit [jekyll](https://jekyllrb.com/) und dem [just-the-docs](https://github.com/just-the-docs/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.

### Lokale Entwicklung

Um an der Webseite lokal weiterzuentwickeln, wird die ruby version benötigt, die in dem [ruby-version file](.ruby-version) aufgeführt ist. Diese wird auch durch GitHub Actions beim Bau der Webseite benutzt. Zusätzlich müssen [die Voraussetzungen für jekyll](https://jekyllrb.com/docs/installation/) erfüllt sein.

Anschließend kann das Repo lokal geklont und der Webserver mit 

```bash

make

```

gestartet werden. 

Die Änderungen am Code werden live im Browser aktualisiert, sofern die [_config.yml Datei](_config.yml) nicht bearbeitet wurde. Bei Änderungen an der _config.yml Datei muss der Webserver neugestartet werden.

> :nerd_face:	**Abkürzung**: Die Webseite kann auch mit diesem [vscode.dev](https://vscode.dev/https://github.com/OlGe404/OlGe404.github.io) Link im Browser geöffnet und bearbeitet werden. Für das Starten des lokalen Webservers mit der Entwicklungsumgebung im Browser kann [GitHub Codespaces](https://github.com/codespaces) genutzt werden.