Skip to content

Commit 977d9cf

Browse files
committed
edits
1 parent 65645a3 commit 977d9cf

File tree

4 files changed

+10
-8
lines changed

4 files changed

+10
-8
lines changed

docs/project/wiki/markdown-guidance.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ ms.date: 06/18/2025
2121

2222
[!INCLUDE [version-selector](../../includes/version-selector.md)]
2323

24-
This article describes the basic syntax for using Markdown (_.md_) format with Azure DevOps features, including [Wiki pages](#use-markdown-in-wikis). Markdown syntax lets you add special formatting to your page content, such as headings, lists, tables, and images. Use Markdown to format your README files, dashboards, pull request content, and so on.
24+
This article describes the basic syntax for using Markdown (_.md_) format with Azure DevOps features, including [Wiki pages](#markdown-in-an-azure-devops-wiki). Markdown syntax lets you add special formatting to your page content, such as headings, lists, tables, and images. Use Markdown to format your README files, dashboards, pull request content, and so on.
2525

2626
You have two formatting options: common [Markdown conventions](https://daringfireball.net/projects/markdown/syntax) and [Markdown extensions for GitHub](https://docs.github.com/get-started/writing-on-github).
2727

@@ -44,7 +44,7 @@ The following table outlines the feature support for different Markdown elements
4444
|-----------------------------------------|:----:|:------:|:---:|:------:|:----:|
4545
| [Headers](#headers) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
4646
| [Paragraphs and line breaks](#breaks) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
47-
| [Blockquotes](#blockquotes) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
47+
| [Block quotes](#block-quotes) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
4848
| [Horizontal rules](#rules) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
4949
| [Emphasis](#emphasis) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
5050
| [Code highlighting](#code) | | | ✔️ | ✔️ | ✔️ |
@@ -122,7 +122,7 @@ The following image shows the published view of the Markdown for spacing in a wi
122122

123123
Quote comments or text to set the context for your new comment or text. The quoted text displays indented from the left margin with a vertical line along the quoted section.
124124

125-
You can add blockquotes in a [Definition of Done (board)](../../boards/boards/add-columns.md#definition-of-done), the [Markdown widget](../../report/dashboards/add-markdown-to-dashboard.md), pull requests, Readme files, and wiki files.
125+
You can add block quotes in a [Definition of Done (board)](../../boards/boards/add-columns.md#definition-of-done), the [Markdown widget](../../report/dashboards/add-markdown-to-dashboard.md), pull requests, Readme files, and wiki files.
126126

127127
To quote a single line of text or a paragraph block, insert a right angle bracket `>` before the first text.
128128

@@ -255,7 +255,9 @@ The following image shows the published view of the Markdown for a portion of te
255255
256256
There's an alternate method for converting a text block into code. When a line of text in the Markdown starts with four spaces in the left margin, the text automatically converts to a code block. The following example demonstrates this behavior:
257257
258+
```md
258259
This article is a Markdown file (_.md_). This line of text automatically formats as code because the line starts with four spaces in the left margin.
260+
```
259261
260262
The preferred approach is to enclose the text within three backticks so you can specify the language identifier. The identifier applies syntax highlighting to the code according to the conventions of the specified language. Identifier labels are available for most programming languages, such as JavaScript (`js`), C# (`csharp`), and Markdown (`md`). For the list of supported languages, see the [highlightjs](https://github.com/highlightjs/highlight.js/tree/stable-11/src/languages) GitHub repository.
261263
@@ -528,14 +530,14 @@ The following example shows a heading and a link its anchor ID:
528530
```md
529531
#### Team #1 : Release Wiki!
530532
531-
For more information, [Visit the Wiki](#team-1--release--wiki).
533+
For more information, [Visit the Wiki](#team-1--release-wiki).
532534
```
533535
534536
Here's the published view:
535537
536538
#### Team #1 : Release Wiki!
537539
538-
> For more information, [Visit the Wiki](#team-1--release--wiki).
540+
> For more information, [Visit the Wiki](#team-1--release-wiki).
539541
540542
You can also link to a heading in another Markdown file by specifying the file name with the anchor ID in the link:
541543
@@ -650,7 +652,7 @@ The code review received :+1::+1: and the team is :smile:
650652
651653
Here's the published view of the emojis:
652654
653-
:::image type="content" source="media/markdown-guidance/markdown-emojis-pull-request.png" alt-text="Screenshot that shows the published view of emojis in a pull request comment.":::
655+
:::image type="content" source="media/markdown-guidance/markdown-emoji-pull-request.png" alt-text="Screenshot that shows the published view of emojis in a pull request comment.":::
654656
655657
### Example: Escape emojis in Markdown
656658
@@ -783,7 +785,7 @@ $$
783785
784786
Here's the published view of the notation in the Markdown file:
785787
786-
:::image type="content" source="media/markdown-guidance/media/markdown-guidance/mathematical-notation-algebra.png" alt-text="Screenshot that shows the published view of the KaTex code snippet that includes inline notation and an algebraic block expression.":::
788+
:::image type="content" source="media/markdown-guidance/mathematical-notation-algebra.png" alt-text="Screenshot that shows the published view of the KaTex code snippet that includes inline notation and an algebraic block expression.":::
787789
788790
### Example: Show sums and integrals
789791
@@ -801,7 +803,7 @@ $$
801803
802804
Here's the published view of the expressions in the Markdown file:
803805
804-
:::image type="content" source="media/markdown-guidance/media/markdown-guidance/mathematical-notation-sums-integrals.png" alt-text="Screenshot that shows the published view of the KaTex code snippet that uses two block expressions to calculate sums and integrals.":::
806+
:::image type="content" source="media/markdown-guidance/mathematical-notation-sums-integrals.png" alt-text="Screenshot that shows the published view of the KaTex code snippet that uses two block expressions to calculate sums and integrals.":::
805807
806808
## Markdown in an Azure DevOps wiki
807809

docs/project/wiki/media/markdown-guidance/markdown-emojis-pull-request.png renamed to docs/project/wiki/media/markdown-guidance/markdown-emoji-pull-request.png

File renamed without changes.

docs/project/wiki/media/markdown-guidance/markdown-escape-emojis.png renamed to docs/project/wiki/media/markdown-guidance/markdown-escape-emoji.png

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)