Files
JAVAkompakt/README.md

39 lines
957 B
Markdown

# JAVAkompakt
Das vorliegende Projekt stellt den Quellcode der Webseite [JAVAkompakt](https://java.lehrerlezius.de) zur Verfügung.
### Voraussetzungen
Die Webseite JAVAkompakt wurde mithilfe des auf [Python](https://www.python.org) basierenden Dokumentationstools [Zensical](https://zensical.org) erstellt.
Als Python-Projekt ist Zensical plattformunabhängig. Neben Python ist die Installation von Zensical Voraussetzung (vgl. auch [Zensical - Get Started](https://zensical.org/docs/get-started/)).
```
pip install zensical
```
### Erzeugen der Website
Der eigentliche Quellcode (d.h. die JavaKompakt Dokumentation) ist im Unterverzeichnis ``docs/`` zu finden.
Ein Live-Preview kann gestartet werden mit:
```
zensical serve
```
Um im Unterverzeichnis ``site/`` die komplette statische Website zu erzeugen nutzen Sie:
```
zensical build
```
### Lizenz
Der Quellcode wie auch die Webseite stehen unter der [CC-BA-SA-4.0](LICENSE) Lizenz.