GLAREAN-Doku/html-module
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
HTML-Module zur GLAREAN-Dokumentation.
9 commits 1 branch 0 tags 180 KiB
Find a file
Exact
Urs Liska 1f1df42676 TMP: outline.md 
Das ist die Gliederung der ersten Schulung. Die Idee war, diese zum
Ausgangspunkt der Gliederung der HTML-Schulungsmaterialien zu
nehmen. Das wird aber wohl nicht gehen.
2020-01-31 11:09:35 +01:00
überblick TMP: outline.md 2020-01-31 11:09:35 +01:00
.gitignore Ignoriere PDF-Dateien 2020-01-30 22:13:17 +01:00
links-zwischen-modulen.md Anleitung für Links zwischen HTML-Modulen 2020-01-31 11:08:43 +01:00
README.md Typo im README 2020-01-30 17:18:21 +01:00

README.md

GLAREAN-Dokumentation mit HTML-Modulen

Dies ist ein Repository zur Pflege von HTML-Modulen zur Dokumentation von GLAREAN. Diese werden in Markdown geschrieben (»autoriert«???) und mit MkDocs erzeugt.

Im Verzeichnis _resources werden Vorlagen, Ressourcen etc. gesammelt, die für die Anlage neuer Module erforderlich sind. Im Lauf der Zeit sollen die Prozesses allerdings nach Möglichkeit weitestgehend automatisiert werden (entweder durch Skripte zur Vorbereitung oder während des MkDocs-Buildprozesses).

Abhängigkeiten

HINWEIS: MkDocs erzeugt statische HTML-Sites, die folgenden Abhängigkeiten sind also nur für den Autor auf seinem lokalen PC erforderlich.

(Ich hoffe, diese Liste ist aktuell)

  • MkDocs
    • Ich habe MkDocs von Github geklont und mittels setup.py installiert. Vermutlich funktionieren die übrigen Installationsmethoden ebenfalls (pip, Distro-Package), doch habe ich diese nicht getestet.
  • Pygments
    • Pygments dient dem Syntax Highlighting, dürfte also für Zwecke der GLAREAN-Dokumentation weitestgehend irrelevant sein
  • Material Theme
    • Verwendetes Theme, Installation mit pip3 install mkdocs-material
    • Weitere Themes auf MkDocs/Wiki

Geplant ist die Implementierung eines PDF-Exports, der die Installation weiterer Plugins und ggfs. externer Tools wie z.B. Pandoc plus LaTeX nötig machen wird.

Lizenz

Diese Dokumentationen werden unter der CC BY-SA 4.0 verfügbar gemacht. Dies gilt für alle Inhaltsdaten, ggfs. entstehender Code kann anders lizensiert werden.