Meta

Hier möchte ich kurz erläutern, wie diese Dokumentation erstellt wird, damit nachfolgende Schüler oder Lehrer sie erweitern können, bei Bedarf.

Aufbau

Diese Webseite besteht aus HTML, CSS und JavaScript Dateien, die alle auf einem Server für alle zugäglich liegen.

Anstatt diese Dokumentation direkt in HTML zu schreiben, verwenden wir einen Werkzeug, was häufig zum Schreiben von statischen Webseiten oder Blogs benutzt wird: Markdown. Markdown ist eine, einfachem Text sehr ähnliche Sprache, in der man formatierten Text schnell und gut lesbar scheiben kann.

Kompilieren

Da allerdings der Webbrowser Markdown - anders als HTML - nicht rendern kann, wird es vorher von einem Programm in HTML übersetzt, "kompiliert".

Wir benutzen hierfür mdBook. Es ist sehr einfach in der Verwendung und, im Vergleich zu Ähnlichem, sehr schnell.

Hosting

Der Markdown-Code für dieses Buch findet ihr in unserem GitHub-Repo.

Bei jedem Commit, also immer dann, wenn wir etwas geändert haben, wird der Code automatisch nach HTML kompiliert. Die erstellte Webseite befindet sich im gh-pages Zweig vom selben Repo.
Hierfür gebrauchen wir die WebApp wercker.com.

Wenn man nun im Browser auf die Webseite stormarnschule.github.io/raspi-book geht, sendet GitHub eben jenen HTML-Code, der im gh-pages Zweig liegt an den WebBrowser.

Bilder

Die Bilder sind alle im PNG Format, dies bietet die beste Qualität bei kleiner Dateigröße. Im Gegensatz zu JPG sieht man keine Pixelfehler oder "Krisel".

Alle Bilder wurden auf eine Breite von 750 px skaliert, so passen sie genau auf eine Seite, ohne vom Browser verkleinert werden zu müssen. Außerdem benutzen einige Bilder Adam7, ein Algorithmus der während es Herunterladens das Bild verfeinert.
Die Verwendung von Adam7 ist von uns empfohlen!