Skip to main content

Informationen zu Wikis

Du kannst die Dokumentation für dein Repository in einem Wiki verwalten, damit andere dein Projekt nutzen und daran mitwirken können.

Wer kann dieses Feature verwenden?

Wikis sind in öffentlichen Repositorys mit GitHub Free und GitHub Free für Organisationen sowie in öffentlichen und privaten Repositorys mit GitHub Pro, GitHub Team, GitHub Enterprise Cloud und GitHub Enterprise Server verfügbar. Weitere Informationen findest du unter GitHub-Pläne.

Jedes Repository zu GitHub.com verfügt über einen Abschnitt zum Hosten von Dokumentationen, die als Wiki bezeichnet werden. Du kannst das Wiki deines Repositorys verwenden, um ausführliche Informationen über dein Projekt auszutauschen, beispielsweise über seine Verwendung, seine Gestaltung und seine Kernprinzipien. Eine README-Datei zeigt schnell, was dein Projekt bezweckt, wohingegen du ein Wiki verwenden kannst, um zusätzliche Dokumentation bereitzustellen. Weitere Informationen findest du unter Informationen zu README-Dateien.

Mit Wikis kannst du Inhalte wie überall sonst auf GitHub verfassen. Weitere Informationen findest du unter Getting started with writing and formatting on GitHub (Erste Schritte beim Schreiben und Formatieren auf GitHub). Wir verwenden unsere Open-Source Markupbibliothek, um verschiedene Formate in HTML zu konvertieren. So kannst du auswählen, ob du in Markdown oder einem beliebigen anderen unterstützten Format schreiben möchtest.

Du kannst Markdown verwenden, um deinem Wiki gerenderte mathematische Ausdrücke, Diagramme, Karten und 3D-Modelle hinzuzufügen. Weitere Informationen zum Erstellen gerenderter mathematischer Ausdrücke findest du unter Schreiben mathematischer Ausdrücke. Weitere Informationen zum Erstellen von Diagrammen, Karten und 3D-Modellen findest du unter Erstellen von Diagrammen.

Wenn Sie ein Wiki in einem öffentlichen Repository erstellen, steht das Wiki für die Öffentlichkeit zur Verfügung. Wenn Sie ein Wiki in einem privaten Repository erstellen, ist das Wiki nur für Personen mit Zugriff auf das Repository zugänglich. Weitere Informationen findest du unter Sichtbarkeit eines Repositorys festlegen.

Du kannst Wikis direkt auf GitHub bearbeiten, oder du kannst Wiki-Dateien lokal bearbeiten. Standardmäßig können nur Personen mit Schreibzugriff auf Ihr Repository Änderungen an Wikis vornehmen. Sie können jedoch allen Personen auf GitHub.com erlauben, an einem Wiki in einem öffentlichen Repository mitzuwirken. Weitere Informationen findest du unter Zugriffsberechtigungen für Wikis ändern.

Hinweis: Suchmaschinen indizieren nur Wikis mit 500 oder mehr Sternen, die du konfigurierst, um die öffentliche Bearbeitung zu verhindern. Weitere Informationen findest du unter Zugriffsberechtigungen für Wikis ändern.

Wenn du Suchmaschinen benötigst, um deine Inhalte zu indizieren, kannst du GitHub Pages in einem öffentlichen Repository verwenden.

Weiterführende Themen