JAVAkompakt

Das vorliegende Projekt stellt den Quellcode der Webseite JAVAkompakt zur Verfügung.

Voraussetzungen

Die Webseite JAVAkompakt wurde mithilfe des auf Python basierenden Dokumentationstools MKDocs und dem Theme MKDocs Material erstellt.

Als Python-Projekt ist MKDocs plattformunabhängig. Neben Python ist die Installation von MKDocs und MKDocs Voraussetzung.

pip install mkdocs
pip install mkdocs-material

Zusätzlich werden die beiden MKDocs Plugins benötigt.

pip install mkdocs-codeinclude-plugin
pip install mkdocs-same-dir

Erzeugen der Website

Um die Webseite zu erzeugen, wechseln Sie zunächst auf der Kommandozeile in das Unterverzeichnis src/.

Ein Live-Preview kann gestartet werden mit:

mkdocs serve

Um im Unterverzeichnis site/ die komplette statische Website zu erzeugen nutzen Sie:

mkdocs build

Lizenz

Der Quellcode wie auch die Webseite stehen unter der CC-BA-SA-4.0 Lizenz.