Ich hatte neulich die Idee, Präsentationen zu erstellen, die als Repository auf Gitlab und/oder Github gehostet werden können und dort auch live als HTML5 für jeden interessierten zu betrachten wären.

Diese Idee hatten vor mir schon andere - ich habe am Ende des Artikels einige Links zusammengestellt, die mir bei diesem Projekt geholfen haben.

Auf Github ist es ein wenig einfacher als auf Gitlab: Hier muss man einfach das Projekt Reveal.JS als Submodul einbinden und anschließend die Konfiguration für die Pages so ändern, dass sie auf den Branch master (oder einen anderen gewünschten) zeigt. Das ist auch schon alles. Ich habe dafür ein Template-Repository eingerichtet, das man einfach klonen kann. In diesem Template-Repo ist eine kleine Beispiel-Präsentation enthalten, die nochmal einige der Facetten zeigt, die mittels Reveal.JS in einer HTML5-Präsentation möglich sind.

Auf Github ist die Erreichung des Ziels ein wenig anders, aber trotzdem sehr einfach. Ich habe mich hier für die Möglichkeit eines zweistufigen Verfahrens entschieden - letztlich wird der Inhalt des Pages-Projekts über einen zweistufigen Prozess erstellt: Stufe eins ist ein Docker-Image, das die entsprechenden Dateien des Reveal.JS-Projekts beinhaltet. Dieses Image wird über eine von Gitlabs CI/CD-Pipelines erstellt. Stufe 2 ist ein Projekt, das dieses Image in einer CI/CD-Pipeline benutzt und die Daten des Anwenders, die die Inhalte der Präsentation ausmachen, zumischt. Auch hier gibt es wieder die Beispiel-Präsentation zur Demonstration der Möglichkeiten von Reveal.JS und als Ausgangspunkt für eigene Ideen.

In beiden Versionen ist bereits alles enthalten, um Quelltexte mit Syntax-Highlighting in Präsentationen ebenso wie mathematische Ausdrücke darstellen zu können. Die Projekte sind so gehalten, dass es ausreichen sollte, ein einfaches Markdown-Dokument zu bearbeiten, wie es auch zum Beispiel in HackMD möglich ist. Die Beispielpräsentation zeigt aber auch, was getan werden muss, wenn man HTML und Markdown mischen möchte - zum Beispiel um komplexere Layouts zu erstellen wie sie etwa mit w3css möglich sind.

Ich habe hier absichtlich weitere Plugins erst einmal nicht mit aufgenommen (aus meiner Sicht wäre die Unterstützung eingebetteter PlantUML-Diagramme der nächste passende Kandidat) und auch nur ein - das vom Template benutzte - Theme fürs Syntax-Highlighting integriert. Dafür ist das ganze ja OpenSource - wer möchte kann die Repositories forken und seinen eigenen Wünschen und Bedürfnissen anpassen...

Links

Artikel, die hierher verlinken