Skip to content

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LiaScript: Alternative zu Hugo? #210

Closed
cagix opened this issue Jan 14, 2024 · 0 comments
Closed

LiaScript: Alternative zu Hugo? #210

cagix opened this issue Jan 14, 2024 · 0 comments

Comments

@cagix
Copy link
Owner

cagix commented Jan 14, 2024

LiaScript ist ein interessantes Projekt. Die Unterlagen werden in einer Art proprietären Markdown-Dialekt formatiert und auf GH o.ä. bereitgestellt. Durch Voranstellen der URL https://liascript.github.io/course/? vor die URL der Markdowndatei wird eine PWA beim Herunterladen erzeugt, die lokal gespeichert ist und auch offline angezeigt werden kann.

Zusammen mit #160 und #82 könnte der Gesamtworkflow deutlich vereinfacht werden:

  • Die Unterlagen werden wie bisher auf GH als Pandoc-Markdown gepflegt
  • GH-Workflows:
    • Ein Workflow erzeugt die Folien als PPTX (separater Branch)
    • Ein Workflow konvertiert das Material 1:1 zu GH-Markdown (separater Branch) - als Defaultbranch konfiguriert, damit dieses Material direkt angezeigt wird (einzelne Dateien, passend verlinkt)
    • Ein Workflow konvertiert das Material in das LiaScript-Format (separater Branch) - dieses wird per LiaScript-Link im ILIAS verlinkt

Wenn die Dateien 1:1 transformiert werden, wäre jede Sitzung eine eigene PWA. Das ist komfortabel, aber wird schnell unübersichtlich für die Studis. Wenn die Dateien in der passenden Reihenfolge in eine Gesamtdatei gemergt werden (mit der passenden internen Verlinkung), dann brauchen die Studis nur einmal die Gesamt-App.

Zusätzlich zu passenden Lua-Filtern wird noch ein Markdown-Template benötigt, welches die aktuell genutzten Hugo-Archetypen ersetzt (Aufbau/Gliederung der VL-Einheiten).

Potentielle Vorteile:

  • Toolchain schlanker und schneller, kein TeX mehr
  • PPTX ist "good enough", lässt sich vor dem Vortrag noch etwas nachbearbeiten und erlaubt Laserpointer-Stift auf dem iPad
  • GH-Markdown unterstützt alle benötigten Elemente, Vorschau "good enough" (Ersatz für die Kurswebseite, ohne das "barocke Bling-Bling" der Hugo-Seite) für den Online-Einsatz
  • LiaScript erlaubt Offline-Use durch Studis
  • LiaScript bringt Features für Quizzes mit
  • LiaScript einmalig per Link im ILAS einzubinden
  • Keine manuelle Interaktion notwendig bei Update der Kursmaterialien, insbesondere kein Down- und Upload der Seitenarchive
  • Reduzierung der externen Abhängigkeiten: statt Hugo und dem Relearn-Theme und der darauf abgestimmten eigenen custom Hugo-Partials nur noch LiaScript

Potentielle Nachteile:

  • LiaScript ist eine One-Man-Show (Bus-Factor 1..2) (andererseits gilt das ebenfalls für das Relearn-Theme - und in der Praxis ist ein Wechsel des Hugo-Themes nicht unbedingt trivial)
  • Hugo-Relearn hat etwas bessere Features: automatischer Dark-/Light-Mode, hierarchische Menü-Bar mit Links auf alle Themen, zusätzlich TOC für jede einzelne Einheit (würde bei LiaScript zusammenfallen in eine gemeinsame Menüleiste), Menü-Leiste ist "collapsed" per Default - in LiaScript ist immer alles offen
  • LiaScript wirkt etwas chaotisch und unübersichtlich, Doku nicht unbedingt auf dem aktuellen Stand, Features proprietäres Markdown (HTML-Kommentare statt YAML)

siehe auch LiaScript/LiaScript#154 (comment) und

@cagix cagix pinned this issue Jan 14, 2024
Repository owner locked and limited conversation to collaborators Jan 26, 2024
@cagix cagix converted this issue into discussion #224 Jan 26, 2024
@cagix cagix unpinned this issue Jan 26, 2024

This issue was moved to a discussion.

You can continue the conversation there. Go to discussion →

Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant