Die Dokumentation für die Deutsche Programmiersprache
Die einzelnen Artikel liegen im Ordner "content" und sind Markdown Dateien. Hugo nutzt die Markdown Dateien um die Website zu generieren.
- Git Repository Klonen
go run ./gen- Artikel für die Standardbibliothek generierenhugo serve- Webserver starten
Mit dem Befehl hugo generiert man alle html Dateien, welche im Ordner /public gespeichert werden.
Über Issues oder Pull-Requests kannst du uns helfen Fehler in der Dokumenation zu beheben.
Um Artikel zu erstellen benutzt man den hugo new content <pfad> Befehl.
Alle Pfade gehen von /content/DE/ aus, also würde hugo new content hallo.md die Datei /content/DE/hallo.md erstellen.
Jeder Artikel beginnt mit einem front-matter der so aussieht:
+++
title = ""
weight = 1
type = "article"
+++
Das Feld title gibt den Text an, der in der Seitenleiste für den Artikel angezeigt wird. weight bestimmt die Reihenfolge. type muss auf "article" bleiben. Diese Felder müssen immer ausgefüllt werden.
Der Pfad der Datei bestimmt die URL des Artikels.
Sections sind Verzeichnisse die mehrere Artikel enthalten. In der Sidebar werden Sections als dropdown menü angezeigt.
Jede Section hat einen speziellen Artikel mit dem Namen: "_index.md".
Diese Datei beginnt mit einem front-matter, welches so aussieht:
+++
title = ""
weight = 1
type = "article"
layout = "single"
+++
Das HTML für die Website außerhalb der Artikel befindet sich im /layouts Verzeichnis.
/_default/baseof.html ist das Kern der Website und bindet alle partials ein.
/article/single.html enthält das Layout für Artikel.
/partials enthält kleinere Teile der Website:
/layouts/404.html definiert die Fehlermeldung falls eine Seite nicht gefunden wurde.
Bilder, Fonts, CSS und JS Dateien befinden sich in /assets ihren jeweiligen Ordnern.
Das favicon liegt in /static/favicon.
Übersetzungsschlüssel für jede Sprache findet man in /i18n.