Syntax guidance for Markdown usage in Wiki

Table of contents (TOC) for Wiki pages

To create a table of contents, add a [[_TOC_]]. The TOC is generated when the tag is added and there's at least one heading on the page.

The [[_TOC_]] can be placed anywhere in the page to render the table of contents. Only Markdown headings are considered for TOC (HTML heading tags aren't).

All HTML and Markdown tags are stripped from the headings while adding it inside the TOC block. For example: Adding bold and italics to a heading text renders the TOC as follows.

Consistency is maintained in the formatting in TOC.

Add Mermaid diagrams to a Wiki page

Wiki supports the following Mermaid diagram types:

1. Sequence diagrams
2. Gantt Charts

To add Mermaid diagrams to a wiki page, use the following syntax:

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

There's also a toolbar button to add a default Mermaid diagram to a wiki page.

Embed videos in a Wiki page

To embed videos from YouTube and Microsoft Streams in a wiki page, use the following syntax:

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

The iframe is the embed iframe block of the YouTube or Microsoft Streams video.

Result:

(The ending ":::" is required to prevent a break in the page)

YAML tags

Any file that contains a YAML block in a Wiki is processed by a table with one head and one row. The YAML block must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. It supports all basic datatypes, lists, and objects as values. The syntax is supported in wiki, code file preview.

Basic example:

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

Tags with list:

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

Embed Azure Boards query results in Wiki

To embed Azure Boards query results in a wiki page as a table, use the following syntax:

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

You can also use the toolbar and the query selector to embed the query results in a wiki page.

@mention users and groups

To @mention users or groups in wiki, key in "@" in the wiki editor. This @mention opens autosuggest, from which you can mention users or groups to get notified by email.

You can also select "@mention" from the edit toolbar.

Page visits for wiki pages

Automatically, you see an aggregated page visits count for the last 30 days on every page.

Use the batch API pagesBatch to see the daily quantity of visits to all pages in a paginated way. They aren't sorted by number of visits, however. For data over 30 days old, you can get all page visits using the rest API. Sort these pages based on the number of visits to get the top 100. You can store these visits in a dashboard or database.

Enter the pound sign (#), and then enter a work item ID.

Example - Embedded 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>

Example - 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>

Result: