Jedes Repository auf GitHub Enterprise Server 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 können Sie 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 jede Person, die auf Ihre GitHub Enterprise Server-Instance zugreifen kann. Wenn Sie ein Wiki in einem privaten oder internen 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 Enterprise Server 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 Ihre GitHub Enterprise Server-Instance erlauben, an einem Wiki in einem öffentlichen Repository mitzuwirken. Weitere Informationen findest du unter Zugriffsberechtigungen für Wikis ändern.
Hinweis: Aus Leistungsgründen weisen Wikis unabhängig vom Dateityp ein vorläufiges Limit von 5.000 Dateien auf. Bei Überschreitung dieses Grenzwerts sind einige Seiten für Benutzer*innen möglicherweise nicht zugänglich. Wenn Sie ein größeres Wiki benötigen, empfehlen wir die Verwendung von GitHub Pages. Weitere Informationen finden Sie unter „GitHub Pages“.