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.

Gitea - Eingebautes Wiki
Gitea – Eingebautes Wiki
Gitea - Eingebautes Wiki
Gitea – Eingebautes Wiki

Über die Weboberfläche könnt ihr sofort Wiki-Seiten erstellen.

Gitea - Eingebautes Wiki
Gitea – Eingebautes Wiki

Nach einem Klick auf eine erstelle Wiki-Seite wird die Adresse des Git-Wikis angezeigt.

Gitea - Eingebautes Wiki
Gitea – Eingebautes Wiki

Die Adresse für das Wiki setzt sich immer wie folgt zusammen

<git-repository-name>.wiki.git
Anzeige/Werbung

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.

Gitea - Eingebautes Wiki - Versionsverlauf
Gitea – Eingebautes Wiki – Versionsverlauf
Gitea - Eingebautes Wiki - Versionsverlauf
Gitea – Eingebautes Wiki – Versionsverlauf

Photo by Patrick Tomasso on Unsplash

(**) Produktpreise und -verfügbarkeit sind zum angegebenen Datum / Uhrzeit korrekt und können sich ändern. Alle Preis- und Verfügbarkeitsinformationen auf https://www.amazon.de/ zum Zeitpunkt des Kaufs gelten für den Kauf dieses Produkts.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.