Syntax-Leitfaden für die Markdownverwendung in Wiki

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

Wichtig

Wählen Sie eine Version aus der Azure DevOps-Inhalts-Versionsauswahl aus.

Um den für Ihre Plattform verfügbaren Inhalt anzuzeigen, stellen Sie sicher, dass Sie die richtige Version dieses Artikels aus der Versionsauswahl auswählen, die sich oberhalb des Inhaltsverzeichnisses befindet. Die Funktionsunterstützung variiert abhängig davon, ob Sie mit Azure DevOps Services oder einer lokalen Version von Azure DevOps Server arbeiten, die von Team Foundation Server (TFS) umbenannt wurde.
Informationen, wie Sie herausfinden, welche lokale Version Sie verwenden, finden Sie unter Welche Plattform/Version verwende ich?

In diesem Artikel finden Sie einige Wiki-spezifische Anleitungen zur Markdownsyntax für die Verwendung in Azure DevOps.

Inhaltsverzeichnis für Wiki-Seiten

Um ein Inhaltsverzeichnis zu erstellen, fügen Sie ein [[_TOC_]] hinzu. Der Toc wird generiert, wenn das Tag hinzugefügt wird und mindestens eine Überschrift auf der Seite vorhanden ist.

Inhaltsverzeichnis

[[_TOC_]] kann an einer beliebigen Stelle auf der Seite platziert werden, um das Inhaltsverzeichnis zu rendern. Nur Markdownüberschriften werden für TOC berücksichtigt (HTML-Überschriftstags werden nicht berücksichtigt).

Alle HTML- und Markdowntags werden aus den Überschriften entfernt, während sie innerhalb des TOC-Blocks hinzugefügt werden. Sehen Sie sich das folgende Beispiel an, wie der Toc gerendert wird, wenn Sie einer Überschrift fett und kursiv hinzufügen.

Tags für TOC

Konsistenz wird in der Formatierung in TOC beibehalten.

Hinweis

Beim Tag [[_TOC_]] wird die Groß-/Kleinschreibung beachtet. Beispielsweise kann [[_toc_]] den Toc nicht rendern. Außerdem wird nur die erste Instanz von [[_TOC_]] gerendert, und der Rest wird ignoriert.

Hinzufügen von Mermaid-Diagrammen zu einer Wiki-Seite

Wiki unterstützt die folgenden Mermaid-Diagrammtypen:

Verwenden Sie die folgende Syntax, um einer Wiki-Seite Mermaid-Diagramme hinzuzufügen:

::: mermaid
<mermaid diagram syntax>
:::

Es gibt auch eine Symbolleistenschaltfläche, um einer Wiki-Seite ein Mermaid-Standarddiagramm hinzuzufügen.

Mermaid-Diagrammvisual

Hinweis

  • Die meisten HTML-Tags und fontawesome werden in der Mermaid-Diagrammsyntax nicht unterstützt.
  • Mermaid wird im Internet Explorer Browser nicht unterstützt.
  • Die vorherigen Diagrammtyplinks beziehen sich auf eine neuere Version von Mermaid, die eine Syntax enthalten kann, die von Azure DevOps nicht unterstützt wird. Beispielsweise unterstützen wir für Flussdiagramme den Live-Editor LongArrow ----> in Mermaid, aber nicht in Azure DevOps.

Einbetten von Videos in eine Wiki-Seite

Verwenden Sie die folgende Syntax, um Videos von YouTube und Microsoft Streams in eine Wiki-Seite einzubetten:

::: video
<iframe width="560" height="315" src="https://www.youtube.com/embed/OtqFyBA6Dbk" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
:::

Der iframe ist der iframe-Einbettungsblock des YouTube- oder Microsoft Streams-Videos.

Ergebnis:

(Das Ende ":::" ist erforderlich, um einen Seitenbruch zu verhindern.)

YAML-Tags

Jede Datei, die einen YAML-Block in einem Wiki enthält, wird von einer Tabelle mit einem Kopf und einer Zeile verarbeitet. Der YAML-Block muss der erste Punkt in der Datei sein und die Form eines gültigen YAML-Satzes zwischen drei gestrichelten Zeilen annehmen. Sie unterstützt alle grundlegenden Datentypen, Listen und Objekte als Werte. Die Syntax wird im Wiki, Codedateivorschau, unterstützt.

Einfaches Beispiel:

---
tag: post
title: Hello world
---

YAML-Tag, einfaches Beispiel

Tags mit Liste:

---
tags:
- post
- code
- web
title: Hello world
---

YAML-Tags mit Listenbeispiel

Einbetten Azure Boards Abfrageergebnisse im Wiki

Verwenden Sie die folgende Syntax, um Azure Boards Abfrageergebnisse in eine Wiki-Seite als Tabelle einzubetten:

::: query-table <queryid>
:::

Beispiel:

::: query-table 6ff7777e-8ca5-4f04-a7f6-9e63737dddf7 :::

Sie können auch die Symbolleiste und die Abfrageauswahl verwenden, um die Abfrageergebnisse in eine Wiki-Seite einzubetten.

Abfrageergebnisse (Symbol)

Bereich

Weitere Informationen zum Kopieren der Abfrage-URL, die eine GUID für die Abfrage bereitstellt, finden Sie unter E-Mail-Abfrageelemente oder Freigabeabfrage-URL.

@mention Von Benutzern und Gruppen

Um Benutzer oder Gruppen im Wiki zu @mention, geben Sie "@" im Wiki-Editor ein. Mit diesem @mention wird die AutomatischeUggeste geöffnet, in der Sie Benutzer oder Gruppen erwähnen können, um per E-Mail benachrichtigt zu werden.

Erwähnen der Automatischen Erfassung

Sie können auch auf der Bearbeitungssymbolleiste "@mention" auswählen.

Erwähnung über die Bearbeitungssymbolleiste

Wenn Sie Seiten direkt im Code bearbeiten, verwenden Sie das folgende Muster: @<{identity-guid}> .

Seitenbesuche für Wiki-Seiten

Automatisch wird auf jeder Seite eine aggregierte Anzahl von Seitenbesuchen für die letzten 30 Tage angezeigt.

Verwenden Sie die Batch-API, pagesBatch um die tägliche Anzahl von Besuchen auf allen Seiten paginiert anzuzeigen. Sie sind jedoch nicht nach anzahl von Besuchen sortiert. Für Daten, die über 30 Tage alt sind, können Sie alle Seitenaufrufe mithilfe der REST-API abrufen. Sortieren Sie diese Seiten basierend auf der Anzahl von Besuchen, um die ersten 100 zu erhalten. Sie können diese Besuchen in einem Dashboard oder in einer Datenbank speichern.

Wiki-Seitenbesuche

Hinweis

Ein Seitenaufruf wird von einem bestimmten Benutzer in einem Intervall von 15 Minuten als Seitenansicht definiert.

Geben Sie das Nummernzeichen ( # ) und dann eine Arbeitselement-ID ein.

Hinweis

Dieses Feature ist mit TFS 2018.2 und höher verfügbar.

HTML-Tagunterstützung auf Wiki-Seiten

Auf Wiki-Seiten können Sie auch umfangreiche Inhalte mit HTML-Tags erstellen.

Tipp

Sie können Markdown in Ihrem HTML-Code schachteln, aber Sie müssen eine leere Zeile zwischen dem HTML-Element und dem Markdown einfügen.

<p>
 
 [A markdown link](https://microsoft.com) 
</p>

Hinweis

Das Einfügen umfangreicher Inhalte als HTML wird in Azure DevOps Server 2019.1 und höher unterstützt.

Beispiel: Eingebettetes Video

<video src="path of the video file" width=400 controls>
</video>
<video src="https://sec.ch9.ms/ch9/7247/7c8ddc1a-348b-4ba9-ab61-51fded6e7247/vstswiki_high.mp4" width=400 controls>
</video>

Beispiel: Rich-Text-Format

<p>This text needs to <del>strikethrough</del> <ins>since it is redundant</ins>!</p>
<p><tt>This text is teletype text.</tt></p>
<font color="blue">Colored text</font>
<center>This text is center-aligned.</center>
<p>This text contains <sup>superscript</sup> text.</p>
<p>This text contains <sub>subscript</sub> text.</p>
<p>The project status is <span style="color:green;font-weight:bold">GREEN</span> even though the bug count / developer may be in <span style="color:red;font-weight:bold">red.</span> - Capability of span
<p><small>Disclaimer: Wiki also supports showing small text</small></p>
<p><big>Bigger text</big></p>

Ergebnis:

Helle Designansicht

Dunkle Designansicht