Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019
Sie können Inhalte veröffentlichen, die Sie bereits in einem Git-Repository in einem Azure DevOps-Wiki verwalten. Ihr Repository kann Dateien für ein Software Development Kit (SDK), Produktdokumentation, README-Inhalte usw. enthalten. Sie können auch mehrere Wikis für ein einzelnes Teamprojekt veröffentlichen.
Wenn Sie Ihre Markdown-Dateien (MD) in einem Wiki veröffentlichen, erhalten Sie mehrere Vorteile:
- Organisieren Sie den Inhalt in einer verwalteten Seitensequenzstruktur.
- Durchsuchen und Filtern des Inhaltsverzeichnisses
- Veröffentlichen neuer Versionen des Inhalts
- Verwalten von Inhalten auf die gleiche Weise, wie Sie Ihre Codebasis verwalten
- Einfaches Durchsuchen des Wikis mithilfe der Wiki-Suchfunktion
Weitere Informationen finden Sie unter Bereitgestelltes Wiki im Vergleich zu veröffentlichtem Code als Wiki.
In diesem Artikel wird beschrieben, wie Sie in einem Wiki veröffentlichte Inhalte mithilfe des Azure DevOps-Webportals und der Azure DevOps CLI hinzufügen und bearbeiten. Sie können auch offline arbeiten und Ihre Wiki-Inhalte auf die gleiche Weise aktualisieren, wie Sie an Code innerhalb eines Git-Repositorys zusammenarbeiten. Weitere Informationen finden Sie unter "Aktualisieren von Wiki-Seiten offline".
Voraussetzungen
| Kategorie | Anforderungen |
|---|---|
| Projektzugriff | Mitglied des Projekts, in dem sich das Wiki befindet. Sie können den Zugriff von Ihrem Projektadministrator bei Bedarf anfordern. |
| Erlaubnisse | Mitglied der Gruppe Mitwirkende. |
| Git-Repository | Ein Git-Repository, das in Ihrem Teamprojekt definiert ist. Im Idealfall enthält das Repository mindestens eine Markdown-Datei, die Sie in Ihrem Wiki veröffentlichen möchten. Weitere Informationen finden Sie unter Erstellen eines neuen Git-Repositorys in Ihrem Projekt. |
Öffnen des Wikis
Stellen Sie mithilfe eines unterstützten Webbrowsers eine Verbindung mit Ihrem Azure DevOps-Projekt her, und wählen Sie "Wiki" aus:
Wenn Sie Ihr Teamprojekt wechseln müssen, wählen Sie 
Azure DevOps aus, um alle Teamprojekte und -teams zu durchsuchen.
Veröffentlichen eines Git-Repositorys in einem Wiki
In diesem Abschnitt wird beschrieben, wie Sie Ihr Git-Repository in einem Wiki veröffentlichen. Sie können direkt mit der Azure DevOps-Benutzeroberfläche im Browser arbeiten oder die Azure DevOps CLI verwenden.
Führen Sie die folgenden Schritte aus, um die Markdown-Dateien in Ihrem Git-Repository in einem Wiki zu veröffentlichen:
Wählen Sie auf der Wiki-Startseite " Code als Wiki veröffentlichen" aus:
Wenn die Option " Code veröffentlichen" nicht als Wiki-Option angezeigt wird, müssen Sie möglicherweise zuerst ein Git-Repository für Ihr Projekt definieren. Folgen Sie den Anweisungen unter Erstellen eines neuen Git-Repositorys, aktualisieren Sie die Wiki-Seite , und kehren Sie dann zu diesem Verfahren zurück.
Wenn Sie bereits über ein Teamprojektwiki verfügen, können Sie das Dropdownmenü des Projekts erweitern und das Codewiki veröffentlichen auswählen:
Wählen Sie im Dialogfeld "Code veröffentlichen als Wiki " das Repository, die Verzweigung und den Ordner aus, der die Markdown-Dateien enthält. Das Git-Repository muss sich innerhalb des Teamprojekts befinden. Wenn Sie alle Markdown-Dateien im Repository in Ihrem Wiki veröffentlichen möchten, wählen Sie den Stamm des Repositorys (
/) als Ordner aus:
Geben Sie einen Namen für das neue Wiki-Repository ein, und wählen Sie "Veröffentlichen" aus. Das Wiki-Repository füllt mit den Markdown-Dateien und Ordnern auf, die in dem ausgewählten Repository enthalten sind.
Die folgende Abbildung zeigt das veröffentlichte Repository für die Dateien, die im im vorherigen Schritt ausgewählten Azure-docs-sdk-node-Repository enthalten sind:
Das Code-Wiki enthält ein Inhaltsverzeichnis:
- Der Inhaltsverzeichnistitel wird vom Markdown-Dateinamen abgeleitet.
- Die Markdown-Dateien (.md) im Repository/Verzweigung/Ordner werden in alphabetischer Reihenfolge aufgeführt.
- Für jeden im veröffentlichten Ordner definierten Unterordner wird eine übergeordnete Seite erstellt, auch wenn der Ordner keine Markdown-Dateien enthält.
Die folgende Abbildung zeigt den Inhaltsverzeichnisinhalt für das Azure-docs-sdk-node-Repository:
Git-Repository-Zweig dem Wiki zugeordnet
Der Kopf des Git-Repo-Branchs wird dem veröffentlichten Code-Wiki zugeordnet. Alle Änderungen, die im Branch und in den ausgewählten Ordnern vorgenommen werden, werden automatisch im veröffentlichten Codewiki angezeigt. Es sind keine anderen Workflows beteiligt.
Hinweis
Sie können bis zu 10 Verzweigungen pro veröffentlichtem Codewiki veröffentlichen.
Für das bereitgestellte Wiki mit den zusätzlichen Markdown-Dateien können Sie Seiten auf die gleiche Weise hinzufügen oder bearbeiten, wie Sie Code in Ihrem Git-Repository verwalten.
Bearbeiten, Umbenennen oder Löschen von Seiten
Im Azure DevOps-Webportal können Sie eine Wiki-Seite bearbeiten, umbenennen oder löschen:
Wählen Sie in Ihrem Projekt Repos>Dateien oder Code>-Dateien aus.
Wählen Sie in der Liste der Dateien die Seite aus, an der Sie arbeiten möchten.
Wählen Sie "Weitere Optionen
" für die Datei aus, und wählen Sie dann die Aktion aus:
Hinweis
Sie können Ihr Wiki-Repository auf die gleiche Weise verwalten, wie Sie andere Git-Repositorys verwalten, indem Sie Verzweigungsrichtlinien für die Verzweigung definieren, die Sie für die Veröffentlichung im Wiki ausgewählt haben. Wenn Sie keine Branchrichtlinien definieren, können Sie auch Änderungen vornehmen und diese direkt über das Webportal oder von einem Client an den Branch übertragen.
In den folgenden Abschnitten wird beschrieben, wie Sie die Aktionen ausführlicher ausführen.
Bearbeiten einer -Seite
Verwenden Sie beim Bearbeiten einer Datei die Links, um eine Vorschau Ihrer Änderungen anzuzeigen oder Änderungen hervorzuheben, die von der vorherigen Version vorgenommen wurden.
Um Ihre Änderungen zu verwerfen, wählen Sie "Abbrechen" aus. Weitere Informationen zu unterstützten Markdown-Features finden Sie unter Syntaxanleitungen für die Markdown-Verwendung.
Wenn Sie fertig sind, fügen Sie einen Kommentar zu Ihren Updates hinzu, und wählen Sie dann "Commit ausführen" aus:
Das System zeigt Ihnen automatisch einen Link zum Erstellen einer Pullanforderung an. Sie können diese Meldung ignorieren, wenn Sie die Wiki-Verzweigung direkt bearbeiten.
Tipp
Wenn Sie den Namen oder die Groß-/Kleinschreibung einer Datei ändern, aktualisieren Sie die ORDER-Datei , die auf die Datei verweist, um die Änderung widerzuspiegeln. Weitere Informationen finden Sie unter Ändern der Seitensequenz, Hinzufügen oder Aktualisieren einer ORDER-Datei.
Umbenennen einer Seite
Alle Seiten, die im Wiki-Inhaltsverzeichnis angezeigt werden sollen, müssen den Dateityp Markdown (MD) verwenden. Sie können die Umbenennen-Aktion verwenden, um eine Datei umzubenennen, einschließlich der Änderung der Dateierweiterung.
Im folgenden Beispiel wird die new-home-page.md Datei in New-Home-Page.md umbenannt. Die entsprechende Seite wird im Wiki-Inhaltsverzeichnis mit der Beschriftung "Neue Startseite" angezeigt.
Seitentitel sind case-sensitive und müssen innerhalb des Ordners eindeutig sein. Der Titel darf höchstens 235 Zeichen umfassen. Weitere Informationen finden Sie unter Namensbeschränkungen für Seitentitel.
Eine Seite löschen
Jede Markdown-Datei, die nicht im Wiki angezeigt werden soll, können Sie aus dem veröffentlichten Ordner löschen. Wenn Sie die Datei in eine ORDER-Datei aufgenommen haben, löschen Sie den entsprechenden Seiteneintrag aus der ORDER-Datei . Weitere Informationen finden Sie unter Ändern der Seitensequenz, Hinzufügen oder Aktualisieren einer ORDER-Datei.
Hinzufügen einer Seite oder mehrerer Seiten
Es gibt verschiedene Möglichkeiten, wie Sie Ihrem veröffentlichten Wiki Seiten hinzufügen können:
- Hinzufügen einer Datei zum Wiki-Stammordner oder einem beliebigen Unterordner
- Hochladen von Dateien in den Wiki-Stammordner oder in einen beliebigen Unterordner
- Hinzufügen oder Aktualisieren einer beliebigen .order-Datei, um die Seitensequenz im Wiki-Inhaltsverzeichnis anzugeben.
Für jedes Update müssen Sie Ihre Änderungen an dem Wiki-Repository übernehmen. Aktualisieren Sie dann Ihr Wiki für Ihr veröffentlichtes Repository, um die Änderungen zu überprüfen.
Hinzufügen einer Seite aus dem Webportal
Führen Sie die folgenden Schritte aus, um Ihrem veröffentlichten Wiki eine Seite hinzuzufügen:
Wechseln Sie im Azure DevOps-Webportal zu Repos>Dateien oder Code>Dateien für das veröffentlichte Repository.
Wählen Sie "Weitere Optionen
" für das Repository und dann "Neue>Datei" aus:
Geben Sie im Dialogfeld einen Namen für die neue Datei ein, die den Dateityp Markdown (.md) enthält.
Der Dateiname sollte dem Seitentitel entsprechen, den Sie im Wiki-Inhaltsverzeichnis anzeigen möchten. Ersetzen Sie alle Leerzeichen im Seitentitel durch Bindestriche (
-) im Dateinamen. Seitentitel sind case-sensitive und müssen innerhalb des Ordners eindeutig sein. Der Titel darf höchstens 235 Zeichen umfassen. Weitere Informationen finden Sie unter Namensbeschränkungen für Seitentitel.Im folgenden Beispiel wird eine Datei namens Page-4.md hinzugefügt, die im Wiki-Inhaltsverzeichnis mit dem Seitentitel "Seite 4" angezeigt wird.
Wählen Sie "Erstellen" aus.
Wenn die Seite in der Dateiliste angezeigt wird, wählen Sie die Seite und dann "Bearbeiten" aus. Geben Sie den Inhalt für die Seite ein. Weitere Informationen finden Sie unter Syntaxanleitungen für Markdown-Dateien, Widgets, Wikis und Pullanforderungskommentare.
Wenn Sie fertig sind, fügen Sie die neue Seite zu Ihrem veröffentlichten Repository hinzu, indem Sie "Commit ausführen" auswählen.
Hochladen von Dateien in einen Ordner
Sie können dateien auch in einen Ordner im veröffentlichten Wiki hochladen. Diese Option ist nützlich, wenn Sie über vorhandene Inhalte verfügen, die Sie hinzufügen möchten.
Wechseln Sie im Azure DevOps-Webportal zu Repos>Dateien oder Code>Dateien für das veröffentlichte Repository.
Wählen Sie "Weitere Optionen
" für das Repository aus, und wählen Sie dann " Datei hochladen" aus:
Wählen Sie im Dialogfeld "Commit" den Ordner und die Dateien aus, die Sie hochladen möchten:
Wenn Sie fertig sind, laden Sie die Dateien in Ihr veröffentlichtes Repository hoch, indem Sie "Commit ausführen" auswählen.
Hinzufügen einer Seite mit Unterseiten
Wenn eine Seite in Ihrem Wiki Unterseiten enthalten soll, benötigen Sie eine Markdown-Datei und einen Ordner mit demselben Namen. Die Datei und der Ordner müssen sich im selben Wiki-Ordner befinden.
Erstellen Sie die neue Markdown-Datei, indem Sie die Schritte unter "Hinzufügen einer Seite" aus dem Webportal ausführen.
Um den entsprechenden Ordner zu erstellen, wählen Sie "Weitere Optionen
" für das Repository und dann "Neuer> aus.Geben Sie im Dialogfeld "Neuer Ordner " den Ordnernamen ein, der mit dem Markdown-Dateinamen identisch sein muss:
Wählen Sie "Erstellen" aus.
Wählen Sie in der Wiki-Dateiliste den neuen Ordner aus. Fügen Sie dem Ordner eine oder mehrere Dateien als Unterseiten hinzu.
Hinzufügen oder Aktualisieren der ORDER-Datei
Nachdem Sie dem veröffentlichten Repository Dateien oder Ordner hinzugefügt haben, besteht der letzte Schritt darin, die ORDER-Datei für alle neuen oder aktualisierten Ordner hinzuzufügen oder zu aktualisieren. Aktualisieren Sie die Seitensequenz, um sicherzustellen, dass die neuen Dateien und Ordner im Wiki-Inhaltsverzeichnis wie erwartet angezeigt werden.
Weitere Informationen finden Sie unter Ändern der Seitensequenz, Hinzufügen oder Aktualisieren einer ORDER-Datei. Alle Dateien, die nicht in der ORDER-Datei aufgeführt sind, werden am Ende der alphabetischen Liste in der Seitensequenz hinzugefügt.
Seitenreihenfolge mit .order-Datei ändern
Die ORDER-Datei im Wiki-Stamm gibt die Anzeigesequenz für Seiten auf der Stammebene an. Die Datei ist eine Nur-Text-Liste mit Seitennamen, die den Markdown-Dateien im Ordner entsprechen, z. B. Willkommen, Support, rel-2025 usw. Jeder Ordner im Wiki verfügt auch über eine ORDER-Datei , die die Seitensequenz für diesen Ordner definiert.
Führen Sie die folgenden Schritte aus, um eine Datei zur Reihenfolge der Aufträge für einen Ordner einzurichten.
Wählen Sie auf der Seite "Codedateien>" die Option "Neue Datei" aus. Nennen Sie die Datei ".order".
Bearbeiten Sie den Dateiinhalt, um die Anzeigesequenz für die Markdown-Dateien im Ordner zu definieren.
Fügen Sie einen Eintrag für jede Seitendatei in dem Ordner hinzu, den Sie für Wiki-Benutzer sichtbar machen möchten.
Bei Seitentiteln wird die Groß-/Kleinschreibung beachtet. Der Eintragstext sollte mit dem Seitentitel und der Groß-/Kleinschreibung übereinstimmen, die im Dateinamen verwendet wird, aber nicht den Dateityp Markdown (MD) enthalten.
Das folgende Beispiel zeigt eine ORDER-Datei für einen Ordner mit fünf Dateien:
readme-version-9
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
Festlegen der Wiki-Startseite
Wenn Sie "Wiki " im Azure DevOps-Webportal auswählen, wird die Startseite für Ihr Wiki geöffnet.
Standardmäßig wird die erste Seite, die Sie hinzufügen, wenn Sie ein Wiki erstellen, als Wiki-Startseite festgelegt. Wenn Ihr Wiki über mehrere Seiten verfügt, wird die erste Datei in der alphabetischen Reihenfolge als Startseite festgelegt.
Sie können angeben, welche Seite als Startseite verwendet werden soll, indem Sie die Seitensequenz in der ORDER-Datei im Wiki-Stamm festlegen. Platzieren Sie den Namen der Homepage in der obersten Zeile in der Stamm-ORDER-Datei :
Wiki-Welcome
Project-Overview
Get-Started
Submit-a-pull-request
team-contacts
readme-version-9
Ordner auf Wiki-Seite höher stufen
Sie können einen Ordner in Ihrem Repository als Seite in Ihrem Wiki anzeigen. Dieser Vorgang wird als Umwandeln eines Ordners in eine Seite bezeichnet.
Für dieses Szenario benötigen Sie die folgende Konfiguration:
Eine Markdown-Datei (MD) in Ihrem Wiki mit demselben Namen wie der Ordner.
Die Markdown-Datei und der Ordner müssen am gleichen Speicherort in der Liste der Wiki-Dateien gleichrangig sein.
Das folgende Beispiel zeigt einen Ordner und eine Markdown-Datei (.md), die beide den Namen "Test" haben. Die Anwesenheit von Peers mit demselben Namen am selben Ort erzeugt eine Seite mit demselben Namen in der Wiki-Reihe.
Auswählen einer Wiki-Version
Wenn Ihr Wiki über mehrere veröffentlichte Versionen verfügt, wird die neueste Version standardmäßig angezeigt.
Sie können eine andere Wiki-Version auswählen, indem Sie die Dropdown-Liste des Zweigs erweitern und die anzuzeigende Version auswählen.
Aufheben der Veröffentlichung eines Codewikis
Wenn Sie nicht mehr möchten, dass ein Git-Repository als Wiki veröffentlicht wird, können Sie die Veröffentlichung des Wikis aufheben.
Warnung
Durch Aufheben der Veröffentlichung eines Wikis wird die Veröffentlichung des gesamten Codewikis aufgehoben, das alle veröffentlichten Versionen des Repositorys enthält.
Wählen Sie in der Wiki-Liste das Wiki aus, das Sie die Veröffentlichung aufheben möchten, wählen Sie "Weitere Optionen " (...) aus. >Veröffentlichungswiki aufheben:
Nachdem Sie die Veröffentlichung aufheben-Aktion ausgewählt haben, wird ein Dialogfeld zur Bestätigung geöffnet.
Wählen Sie im Bestätigungsdialogfeld die Option "Veröffentlichung aufheben" aus:
