Skip to content

Latest commit

 

History

History
83 lines (55 loc) · 4.47 KB

README.md

File metadata and controls

83 lines (55 loc) · 4.47 KB
Raw

Webseite des Curry Club Augsburg Build Status

Siehe auch: Wiki, Liste von Issues

Der master-Branch enthält den Inhalt der Webseite. Das Haskell-Programm curry-site.hs erzeugt aus den Inhalten eine statische Webseite. Es benutzt dafür die Haskell-Bibliothek Hakyll. Die generierten statischen Dateien werden im gh-pages-Branch hochgeladen und von GitHub Pages unter der URL curry-club-augsburg.de verfügbar gemacht.

Der Continuous-Integration-Dienst Github Actions wird dazu verwendet, die Seite bei Änderungen im master-Branch neu zu bauen und das Ergebnis in gh-pages zu veröffentlichen. Das Schild neben der Überschrift zeigt an, ob der letzte Buildvorgang erfolgreich war.

Neuer Blogeintrag

Einträge schreiben wir mit Markdown. Ein Beispiel ist posts/2015-03-17-hallo-welt.md.

Links innerhalb der Seite müssen vom „root“ aus angegeben werden, also z.B. für Bilder /images/foobar.png.

Metadaten werden mit --- eingeschlossen, am Anfang der Datei. Mögliche Felder sind:

  • title: Titel
  • author: Autor
  • image: Bild am Anfang (optional)
  • image-alt: Alt-Text für das Bild. Bitte bei Verwendung eines Bilds immer angeben (optional)
  • image-attr: Bildquelle (optional)
  • meetup-announcement: Datum des Treffens, für das der Post die Ankündigung ist (optional, muss nur gesetzt werden, wenn der Post eine Ankündigung ist)

Teilüberschriften starten mit # und dann für jede Ebene ein # mehr.

Eine Bildquelle im Text kann mit

<figure>
![xkcd about regular expressions](/images/regular_expressions.png)
<figcaption class="attribution"><cite><a href="https://xkcd.com/208/">xkcd 208</a></cite></figcaption>
</figure>

angegeben werden. cite sollte gemäß der HTML-Spezifikation den vollen Titel der Quelle enthalten.

Der Post, dessen meetup-announcement-Datum am nähesten in der Zukunft liegt, wird auf der Hauptseite angezeigt und gibt das Datum des nächsten Treffens an.

Änderungen am Inhalt

Kleinere Änderungen kann man gut im GitHub Webinterface vornehmen. Es vergehen ca. vier Minuten, bis Github Actions die Seite neu gebaut hat.

Änderungen an curry-site.hs

Für Änderungen am Aufbau und Design der Seite empfiehlt es sich, lokal zu arbeiten, damit man Änderungen schneller sieht. Wenn man das Repo geklont hat, muss man zuerst die Abhängigkeiten installieren und curry-site.hs kompilieren.

Mit Stack:

$ stack install

Oder mit Nix:

$ nix-shell
[nix-shell] $ cabal build

Dann kann man curry-site build aufrufen. Das Programm generiert die Webseite neu und legt die statischen Dateien in den Ordner _site. Zum Debuggen kann man curry-site build -v verwenden.

Das benutzt standardmäßig stack zum Generieren des CSS, wenn cabal bevorzugt wird (z.B. weil stack durch nix überflüssig ist), kann das mittels Env-Variable festgelegt werden: env backend=cabal curry-site build.

Sobald man mit dem Ergebnis zufrieden ist, macht man einen Commit und pusht zum master-Branch. Dann wartet man, bis Github Actions die Webseite neu generiert hat.

Potentiell kontroverse Änderungen

Wenn man den Anderen die Änderungen erst einmal zeigen möchte, kann man folgenden Workflow verwenden:

  • Forke dieses Repository.
  • Mache lokal deine Änderungen.
  • Rufe ./deploy.sh git@github.com:deingithubname/curry-club-augsburg.de.git auf. (Das baut die Seite und pusht das Ergebnis in den gh-pages-Branch von deinem Fork.)
  • Committe deine Änderungen in einem speziellen Feature-Branch und push die Commits zu in deinen Fork.
  • Starte einen Pull-Request, in dem du auf http://deingithubname.github.io/curry-club-augsburg.de/ verlinkst.