Dieses Repository realisiert folgende Funktionalität:
-
Markdown Dateien (.md), die sich im Ordner docs befinden, werden via pandoc als pdf Dateien exportiert und finden sich dann im Ordner pdfs bzw. als html im Ordner html.
-
Draw.io Grafiken (.drawio) im Ordner docs werden gewandelt nach SVG und im Ordner docs/images abgelegt.
-
Umlet Dateien (.uxf) im Ordner docs werden gewandelt nach SVG und im Ordner docs/images abgelegt.
-
Wenn in Github auch noch pages aktiviert wurden, dann werden die Markdown Dateien zusätzlich noch nach html exportiert und können über https://{github Benutzer name}.github.io/{Name des Repositories}/docs/bsp.html abgerufen werden. Wobei bsp.md die zugehörige Markdown Datei ist. Für github Pages muss sich die Datei _config.yml im Wurzelverzeichnis des Repositories befinden. Minimal mit folgendem Inhalt:
plugins:
- jekyll-relative-links
relative_links:
enabled: true
collections: true
include:
- README.md
- bsp.md
- Markdown Dateien im Ordner docs werden ferner via mkdocs gerendert als html Dateien. Der Output erfolgt default mäßig in den Ordner site. Zur Konfiguration muss sich die Dateil mkdocs.yml im Wurzelverzeichnis des Repositories befinden. Ferner muss sich im Ordner javascript die Datei mathjax.js befinden. Minimal hat die Datei folgenden Inhalt:
site_name: MyTest
nav:
- Home: bsp.md
Der zugehörige Kurs findet sich hier
Um diese Funktionalität zu nutzen muss:
- das Repository geklont werden und auf github gehostet werden. Will man lieber gitlab verwenden, so kann hier das Repository gespiegelt werden. Der dazu notwendige Personal Access Token für gitlab muss über die Rechte Repository und Actions verfügen.
- Für Github muss GitHub Pages aktiviert werden.