Gitea - Eingebautes Wiki für die Projektdokumentation nutzen
Gitea bietet die Möglichkeit ein eingebautes Wiki für die Dokumentation des Git-Projekts zu nutzen. Wiki-Seiten sind dabei nichts anderes als einzelne Markdown-Dateien, die in einem eigenen Unter-Verzeichnis verwaltet werden und ebenfalls über eine eigene Versionsverwaltung verfügen.
Die Wiki-Funktion ist sehr hilfreich, wenn ihr eurer Projekt mit mehr als einer README-Datei dokumentieren möchtet.
Wiki-Seiten lassen sich über zwei Möglichkeiten erstellen und bearbeiten:
- Weboberfläche - mit einem eingeschränkten Funktionsumfang
- auf dem Client mit eurem favorisierten Markdown-Editor, die ihr mit CLI (z.B. Git Bash) auf den Server in das Wiki laden könnt.
Legt euch ein neues Git Repository auf eurem Gitea-Server an und aktiviert die interne Wiki-Funktion.
Über die Weboberfläche könnt ihr sofort Wiki-Seiten erstellen.
Nach einem Klick auf eine erstelle Wiki-Seite wird die Adresse des Git-Wikis angezeigt.
Die Adresse für das Wiki setzt sich immer wie folgt zusammen
.wiki.git
Beispiel:
Das Git-Repo im Beispiel ist
test-mit-wiki
Der clone
-Befehl ist damit
git clone ssh://git@192.168.178.3/benutzer/test-mit-wiki.git
Möchtet ihr nun auch die Dateien des Wikis klonen, dass müsst ihr das wie ein komplett neues Git Repository behandeln.
Der clone
-Befehl für das Wiki ist
git clone ssh://git@192.168.178.3/benutzer/test-mit-wiki.wikigit
Damit kommt das Wiki, also die einzelnen Markdown-Dateien auf euren PC.
Die Änderungshistorie könnt ihr wie bei einem Git Repo üblich einsehen.
Gib mir gerne einen Kaffee ☕ aus ❗️
Wenn dir meine Beiträge gefallen und geholfen haben, dann kannst du mir gerne einen Kaffee ☕️ ausgeben.
Follow Me❗️
Source
Photo by Patrick Tomasso on Unsplash