Wikis

Jedes Repository kann ein Wiki hosten – eine separate Sammlung von Markdown-Seiten für Dokumentation, die neben dem Code liegt, ohne sich mit ihm zu vermischen.

Wiki aktivieren

Öffnen Sie das Repository und wählen Sie Einstellungen.
Aktivieren Sie unter Merkmale die Option Wiki.
In der Repository-Navigation erscheint die Registerkarte Wiki.

Seiten erstellen und bearbeiten

Wählen Sie die Registerkarte Wiki.
Wenn das Wiki noch keine Seiten hat, wählen Sie Create the First Page. Wählen Sie andernfalls New Page.
Geben Sie einen Seitentitel ein. Der Titel wird zur URL der Seite, wählen Sie daher etwas Klares und Beständiges.
Schreiben Sie den Inhalt in Markdown und wählen Sie dann Save Page.

Die erste Seite, die Sie erstellen, wird zur Startseite des Wikis – der Seite, auf der Besucher standardmäßig landen. Um eine vorhandene Seite zu aktualisieren, öffnen Sie sie und wählen Sie Bearbeiten. Jedes Speichern erzeugt einen neuen Eintrag im Revisionsverlauf der Seite.

Wiki organisieren

Zwei speziell benannte Seiten steuern die Navigation im gesamten Wiki:

_Sidebar – eine benutzerdefinierte Seitenleiste, die auf jeder Seite angezeigt wird. Fügen Sie hier Links zu Ihren wichtigsten Seiten hinzu.
_Footer – eine Fußzeile, die am Ende jeder Seite angezeigt wird.

Erstellen Sie eine von beiden über New Page mit dem oben angegebenen exakten Namen. Verlinken Sie Wiki-Seiten mit Standard-Markdown untereinander und verweisen Sie dabei auf den Seiten-Slug:

See the [Setup Guide](setup-guide) for installation steps.

Verwenden Sie von Anfang an aussagekräftige Seitentitel: Der Titel wird zur URL, und das spätere Umbenennen einer Seite bricht alle vorhandenen Links darauf.

Wiki lokal bearbeiten

Das Wiki ist selbst ein Git-Repository und unter der .wiki.git-URL Ihres Repositorys verfügbar. Klonen Sie es, bearbeiten Sie die Markdown-Dateien in Ihrem Editor und pushen Sie die Änderungen zurück.

git clone https://git.example.plaidcloud.com/you/my-repo.wiki.git
cd my-repo.wiki
# edit or add .md files
git add .
git commit -m "Expand the setup guide"
git push

Hier funktioniert dasselbe persönliche Zugriffstoken wie für das Haupt-Repository. Jede Markdown-Datei wird zu einer Wiki-Seite; der Dateiname (ohne die Endung .md) ist der Seiten-Slug.