diff options
| -rw-r--r-- | www/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/www/README.md b/www/README.md new file mode 100644 index 0000000..fbae74e --- /dev/null +++ b/www/README.md @@ -0,0 +1,31 @@ +# Website `heimfeld.hamburg` + +Hier sind alle Komponenten untergebracht, um die Website auf dem Server darzustellen: Inhalte und Konfiguration. + +## Abläufe + +### Lokale Vorschau + +```bash +nix run .#preview +``` + +Es öffnet sich ein Browserfenster und aktualisiert sich selbst, sobald an den Inhalten etwas geändert wird. + +### Website veröffentlichen + +```bash +nix run .#publish +``` + +Die Inhalte der Website werden auf den Server kopiert. + +Bestehende Daten werden überschrieben. +Zur Wiederherstellung die Versionsgeschichte nutzen. + +## Architektur + +Dieses Verzeichnis ist im Sinne des Änderungsverlauf von der Infrastruktur isoliert, sodass man es bei Bedarf mit `git filter-repo` (um Platz im Hauptverzeichnis zu sparen) oder `git subtree split` (für eine separate Darstellung) komplett heraustrennen kann. + +Der [`html`](./html) Unterorder kann ebenfalls für sich stehen, wenn man nur die Versionsgeschichte der Inhalte gesondert betrachten will. +Daher sind alle Hilfswerkzeuge und Infrastruktur-Konfiguration außerhalb untergebracht. |