Dokumentations Guide

Wie und wo?

Die Dokumentationsdatei erstellt ihr in unserem Repository im Ordner www/documentation. Wählt einen griffigen und selbsterklärenden Namen, denn der Name der Datei wird als Link auf der Indexseite angezeigt.
Wichtig:
Eure Datei muss auf .md (Markdown) enden. Anderenfalls wird sie nicht ins /var/www/html/dh2018 übersetzt.

Nun könnt ihr eure Dokumentation in Markdown schreiben. Ein paar Grundlegende Befehle sind in der Markdowndoku beschrieben. Wenn ihr noch eine Nützliche Syntax entdeckt, die nicht in Doku festgehalten ist, fügt sie gerne hinzu. :)

Wenn ihr fertig seid müsst ihr eure Änderungen einfach committen und pushen. Eure Dokumentation wird automatisch auf der Indexseite verlinkt und in /var/www/html/dh2018/doku/ als Htmlseite gespeichert.

Bilder

Wenn ihr Bilder einfügen wollt, dann packt diese ins Repository in den Ordner www/pictures. Die Bilder werden dann im /var/www/ unter dem Pfand /dh2018/markdownPictures/Bild.jpg hinterlegt. Dieser Link muss auch in Markdown als Bildpfad angegeben werden.

Einige Richtlinien

Noch gibt es keine :P