tools-only Azure DevOps Wiki Markdown Reference
Complete Markdown syntax reference for Azure DevOps wikis.
Basic Formatting
Headers
# H1 - Page Title
## H2 - Major Section
### H3 - Subsection
#### H4 - Minor Section
##### H5 - Detail
###### H6 - Fine Detail
Text Emphasis
*italic* or _italic_
**bold** or __bold__
***bold italic*** or ___bold italic___
~~strikethrough~~
Line Breaks
Line 1
Line 2 (two spaces before line break)
New paragraph (blank line between)
Lists
Unordered Lists
- Item 1
- Item 2
- Nested item 2a
- Nested item 2b
- Item 3
* Also works with asterisks
+ And plus signs
Ordered Lists
1. First item
2. Second item
1. Nested ordered
2. Another nested
3. Third item
Task Lists
- [ ] Incomplete task
- [x] Completed task
- [ ] Another pending task
Links
Basic Links
[Link Text](https://example.com)
[Link with Title](https://example.com "Hover title")
Wiki Page Links
# Same folder
[Related Page](./page-name)
# Subfolder
[Child Page](./folder/page-name)
# Parent folder
[Parent](../page-name)
# Absolute from wiki root
[Home](/Home)
# Another wiki in same project
[Other Wiki Page](/Wiki-Name/Page-Name)
Anchor Links (Headings)
# Within same page
[Jump to Section](#section-heading)
# In another page
[Section in Other Page](./other-page#section-heading)
Anchor ID rules:
- Spaces → hyphens
- Uppercase → lowercase
- Special characters removed
- Example:
## Team #1 : Release!→#team-1--release
Work Item Links
#123 <!-- Links to work item 123 -->
[Bug #123](#123) <!-- Custom link text -->
AB#123 <!-- Links across projects -->
Images
Basic Image
Image with Size
 <!-- Width x Height -->
 <!-- Width only -->
 <!-- Height only -->
Image as Link
[](full-size.png)
Code
Inline Code
Use the `console.log()` function for debugging.
Code Blocks
```javascript
function hello(name) {
console.log(`Hello, ${name}!`);
}
```
Supported Languages
| Language | Identifier |
|---|---|
| JavaScript | javascript, js |
| TypeScript | typescript, ts |
| Python | python, py |
| C# | csharp, cs |
| Java | java |
| Go | go |
| Rust | rust |
| SQL | sql |
| Bash/Shell | bash, shell, sh |
| PowerShell | powershell, ps |
| YAML | yaml, yml |
| JSON | json |
| XML | xml |
| HTML | html |
| CSS | css |
| Markdown | markdown, md |
Tables
Basic Table
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Cell 1 | Cell 2 | Cell 3 |
| Cell 4 | Cell 5 | Cell 6 |
Alignment
| Left | Center | Right |
|:-----|:------:|------:|
| L | C | R |
| L | C | R |
Table with Formatting
| Feature | Status | Notes |
|---------|--------|-------|
| **Auth** | `Done` | OAuth2 implemented |
| *Cache* | `WIP` | Redis integration |
| ~~Old~~ | Removed | Deprecated v1 |
Blockquotes
Basic Quote
> This is a quote.
> Multiple lines work too.
Nested Quotes
> Level 1
>> Level 2
>>> Level 3
Alert Boxes (Azure DevOps specific)
> [!NOTE]
> Information the user should notice.
> [!TIP]
> Optional helpful advice.
> [!IMPORTANT]
> Essential information required for success.
> [!CAUTION]
> Advises about risks or negative outcomes.
> [!WARNING]
> Dangerous outcomes with potential data loss.
Horizontal Rules
---
***
___
Special Wiki Features
Table of Contents
[[_TOC_]]
Place on its own line. Auto-generates from headings.
YAML Metadata
---
title: Page Title
author: Team Name
updated: 2024-01-15
tags:
- category1
- category2
---
Must be at the very beginning of the file.
User Mentions
@username <!-- Mention specific user -->
@<Team Name> <!-- Mention team/group -->
Page Visit Count
Automatically displayed in wiki. Access via Page Info.
Mermaid Diagrams
Flowchart
::: mermaid
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Action 1]
B -->|No| D[Action 2]
C --> E[End]
D --> E
:::
Note: Use graph not flowchart (unsupported in Azure DevOps).
Sequence Diagram
::: mermaid
sequenceDiagram
participant C as Client
participant S as Server
participant D as Database
C->>S: Request
S->>D: Query
D-->>S: Results
S-->>C: Response
:::
Gantt Chart
::: mermaid
gantt
title Project Timeline
dateFormat YYYY-MM-DD
section Phase 1
Research :a1, 2024-01-01, 30d
Development :after a1, 60d
section Phase 2
Testing :2024-04-01, 30d
Deployment :2024-05-01, 7d
:::
Class Diagram
::: mermaid
classDiagram
class Animal {
+String name
+int age
+makeSound()
}
class Dog {
+bark()
}
Animal <|-- Dog
:::
State Diagram
::: mermaid
stateDiagram-v2
[*] --> Idle
Idle --> Processing : Start
Processing --> Complete : Success
Processing --> Error : Failure
Complete --> [*]
Error --> Idle : Retry
:::
Pie Chart
::: mermaid
pie title Distribution
"Category A" : 45
"Category B" : 30
"Category C" : 25
:::
Entity Relationship
::: mermaid
erDiagram
USER ||--o{ ORDER : places
ORDER ||--|{ LINE_ITEM : contains
PRODUCT ||--o{ LINE_ITEM : "ordered in"
:::
HTML Support
Allowed HTML Tags
<br> <!-- Line break -->
<hr> <!-- Horizontal rule -->
<p> <!-- Paragraph -->
<div> <!-- Division -->
<span> <!-- Inline container -->
<b>, <strong> <!-- Bold -->
<i>, <em> <!-- Italic -->
<u> <!-- Underline -->
<sub> <!-- Subscript -->
<sup> <!-- Superscript -->
<font> <!-- Font styling -->
<table>, <tr>, <td>, <th> <!-- Tables -->
<ul>, <ol>, <li> <!-- Lists -->
<a> <!-- Links -->
<img> <!-- Images -->
Collapsible Sections
<details>
<summary>Click to expand</summary>
Content here (note the blank line after summary)
- Supports Markdown inside
- Multiple paragraphs work
- Code blocks too
</details>
Colored Text
<font color="red">Red text</font>
<font color="#00FF00">Green text (hex)</font>
<span style="color:blue">Blue text</span>
Embedded Video
<video src="https://example.com/video.mp4" width="400" controls>
</video>
Mathematical Notation (KaTeX)
Inline Math
The formula $E = mc^2$ is famous.
Block Math
$$
\sum_{i=1}^{n} x_i = x_1 + x_2 + ... + x_n
$$
Common Symbols
| Symbol | Syntax |
|---|---|
| Fraction | $\frac{a}{b}$ |
| Square root | $\sqrt{x}$ |
| Exponent | $x^2$ |
| Subscript | $x_i$ |
| Sum | $\sum_{i=1}^{n}$ |
| Integral | $\int_{a}^{b}$ |
| Greek letters | $\alpha, \beta, \gamma$ |
| Infinity | $\infty$ |
Escaping Characters
Backslash Escape
\*Not italic\*
\#Not a heading
\[Not a link\]
\`Not code\`
Characters to Escape
| Character | Escaped |
|---|---|
* |
\* |
_ |
\_ |
# |
\# |
[ |
\[ |
] |
\] |
( |
\( |
) |
\) |
` |
\` |
\ |
\\ |
Limitations
Not Supported
- JavaScript/iframes
- Custom CSS
flowchartMermaid syntax (usegraph)- Some HTML tags
- Font Awesome icons
- Long Mermaid arrows (
---->)
File Restrictions
| Restriction | Limit |
|---|---|
| Page size | 18 MB |
| Attachment size | 19 MB |
| Path length | 235 chars |
| Characters in filename | No /, \, # |