Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
# Azure DevOps Markdown Guidance

This reference describes Markdown syntax supported by Azure DevOps features including Wiki pages, README files, dashboards, and pull requests.

## Supported Features

| Markdown type | Definition of Done | Widget | Pull Requests | README | Wiki |
|---|---|---|---|---|---|
| Headings | Yes | Yes | Yes | Yes | Yes |
| Paragraphs/line breaks | Yes | Yes | Yes | Yes | Yes |
| Blockquotes | Yes | Yes | Yes | Yes | Yes |
| Horizontal rules | Yes | Yes | Yes | Yes | Yes |
| Emphasis (bold, italic) | Yes | Yes | Yes | Yes | Yes |
| Tables | No | Yes | Yes | Yes | Yes |
| Lists (ordered, unordered) | Yes | Yes | Yes | Yes | Yes |
| Links | Yes | Yes | Yes | Yes | Yes |
| Images | No | Yes | Yes | Yes | Yes |
| Code highlighting | No | Yes | Yes | Yes | Yes |
| Math notation | No | No | Yes | Yes | Yes |
| Checklists/task lists | No | No | Yes | Yes | Yes |
| Mermaid diagrams | No | No | No | No | Yes |

> **Note:** Markdown in Azure DevOps doesn't support JavaScript or iframes.

## Headings

```markdown
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
```

## Paragraphs and Line Breaks

Use a blank line for new paragraphs. Use two spaces at line end or `<br/>` for line breaks within a paragraph.

## Blockquotes

```markdown
> Single blockquote
>> Nested blockquote
```

## Horizontal Rules

Use three or more hyphens, asterisks, or underscores on a line by themselves.

## Emphasis

```markdown
*Italic* or _Italic_
**Bold** or __Bold__
***Bold italic***
~~Strikethrough~~
```

## Code Highlighting

**Inline:** Use single backticks `` `code` ``

**Block:** Use triple backticks with optional language identifier:

````markdown
```javascript
const x = 1;
```
````

Supported languages include: ActionScript, Apex, Bash, C, C#, C++, CSS, Dart, Go, Groovy, Haskell, HTML, Java, JavaScript, JSON, Kotlin, Lua, Markdown, Objective-C, Perl, PHP, PowerShell, Python, R, Ruby, Rust, Scala, Shell, SQL, Swift, TypeScript, XML, YAML, and more.

## Tables

```markdown
| Header 1 | Header 2 |
|----------|----------|
| Cell 1 | Cell 2 |
```

Alignment with colons: `:---` (left), `:---:` (center), `---:` (right).

## Lists

**Ordered:**

```markdown
1. First item
2. Second item
```

**Unordered:**

```markdown
- Item 1
- Item 2
```

**Nested:** Indent with spaces.

## Links

```markdown
[Link text](URL)
[Link text](URL "Title")
```

**Anchor links:** Link to headings within the same page using `#section-name`.

## Images

```markdown
![Alt text](image-url)
![Alt text](image-url =WIDTHxHEIGHT)
```

Azure DevOps supports image resizing with `=WIDTHxHEIGHT` syntax.

## Checklists / Task Lists

```markdown
- [ ] Incomplete task
- [x] Completed task
```

## Mathematical Notation

**Inline:** `$` delimiters: `$e^{i\pi} = -1$`

**Block:** `$$` delimiters:

```markdown
$$
\sum_{i=1}^{n} x_i
$$
```

Uses KaTeX for rendering.

## Mermaid Diagrams (Wiki only)

````markdown
```mermaid
graph TD;
A-->B;
B-->C;
```
````

Supports: flowcharts, sequence diagrams, Gantt charts, and more.

## Collapsible Sections

```html
<details>
<summary>Click to expand</summary>

Content here (leave blank line after summary tag).
</details>
```

## Emoji

Use standard emoji shortcodes: `:smile:`, `:thumbsup:`, etc.

## Special Characters

Escape special Markdown characters with backslash: `\*`, `\#`, `\[`, etc.

## HTML Tags

Supported HTML tags in Wiki include: `<div>`, `<span>`, `<img>`, `<br>`, `<table>`, `<tr>`, `<td>`, `<th>`, `<strong>`, `<em>`, `<code>`, `<pre>`, `<blockquote>`, `<ul>`, `<ol>`, `<li>`, `<h1>`-`<h6>`, `<hr>`, `<p>`, `<a>`, `<details>`, `<summary>`, `<video>`, `<audio>`.
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ When converting documentation, do **not** halt the conversion when the text docu

When in doubt, consult these resources for markdown best practices:

- [GitHub Basic Writing and Formatting Syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
- [Markdown Extended Syntax](https://www.markdownguide.org/extended-syntax/)
- [Azure DevOps Markdown Guidance](https://learn.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance?view=azure-devops)
- [GitHub Basic Writing and Formatting Syntax](./github-basic-formatting.md)
- [Markdown Extended Syntax](./markdown-extended-syntax.md)
- [Azure DevOps Markdown Guidance](./azure-devops-markdown-guidance.md)
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
# GitHub Basic Writing and Formatting Syntax Reference

## Headings

Create hierarchy using 1-6 hash symbols. GitHub automatically generates a table of contents when you use multiple headings.

```markdown
# First-level heading
## Second-level heading
### Third-level heading
```

## Text Styling

| Style | Syntax | Example |
|-------|--------|---------|
| Bold | `** **` or `__ __` | `**bold text**` |
| Italic | `* *` or `_ _` | `*italicized text*` |
| Strikethrough | `~~ ~~` | `~~mistaken text~~` |
| Bold & italic | `** **` and `_ _` | `**_extremely_ important**` |
| Subscript | `<sub> </sub>` | `<sub>subscript</sub>` |
| Superscript | `<sup> </sup>` | `<sup>superscript</sup>` |
| Underline | `<ins> </ins>` | `<ins>underlined</ins>` |

## Quoting Text

Use `>` to create block quotes:

```markdown
> Text that is a quote
```

## Code Formatting

**Inline code:** Use single backticks for code within sentences:

```markdown
Use `git status` to list changes.
```

**Code blocks:** Use triple backticks for standalone code:

````markdown
```
git status
git add
git commit
```
````

## Color Support

Display colors using supported models within backticks:

- Hex: `` `#0969DA` ``
- RGB: `` `rgb(9, 105, 218)` ``
- HSL: `` `hsl(212, 92%, 45%)` ``

## Links

Wrap link text in brackets and URL in parentheses:

```markdown
[Link text](https://example.com)
```

**Section links:** Link directly to any heading using its anchor.

**Relative links:** Use paths relative to current file:

```markdown
[Contribution guidelines](docs/CONTRIBUTING.md)
```

## Images

Include images using exclamation mark, alt text in brackets, and URL in parentheses:

```markdown
![Alt text](image-url.png)
```

The `<picture>` HTML element is supported for theme-adaptive images.

## Lists

**Unordered lists:** Use `-`, `*`, or `+`

**Ordered lists:** Use numbers followed by periods

**Nested lists:** Indent items under parent items using spaces or tabs

## Task Lists

Create checkboxes with `[ ]` for incomplete and `[x]` for complete tasks:

```markdown
- [x] Completed task
- [ ] Incomplete task
```

## Mentions & References

- **Mention people/teams:** `@username` or `@organization/team-name`
- **Reference issues:** `#` followed by issue number or title

## Emojis

Use `:EMOJICODE:` format: `:+1:`, `:shipit:`

## Paragraphs & Line Breaks

Create paragraphs by leaving blank lines between text. For line breaks:

- Two trailing spaces at line end
- Backslash `\` at line end
- HTML `<br/>`

## Footnotes

```markdown
Here is a footnote[^1].

[^1]: Footnote content here.
```

Footnotes render at document bottom regardless of placement.

## Alerts

Five alert types emphasize critical information:

```markdown
> [!NOTE]
> Essential information users should know.

> [!TIP]
> Helpful advice for better outcomes.

> [!IMPORTANT]
> Key information for success.

> [!WARNING]
> Urgent information requiring immediate attention.

> [!CAUTION]
> Warns about risks and negative outcomes.
```

## Special Features

- **HTML comments:** `<!-- Hidden content -->`
- **Escape formatting:** Backslash before markdown characters: `\*not italicized\*`
Loading