You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -265,7 +265,7 @@ The following examples show how to identify a text block as JavaScript or C#. Yo
265
265
266
266
**JavaScript**
267
267
268
-
```
268
+
```Code Snippet
269
269
<!-- ```js - Three backticks and identifier 'js' -->
270
270
const count = records.length;
271
271
<!-- ``` - Three backticks -->
@@ -279,7 +279,7 @@ const count = records.length;
279
279
280
280
**C#**
281
281
282
-
```
282
+
```Code Snippet
283
283
<!-- ```csharp - Three backticks and identifier 'csharp' -->
284
284
Console.WriteLine("Hello, World!");
285
285
<!-- ``` - Three backticks -->
@@ -320,11 +320,11 @@ Organize structured data with Markdown tables. You can add tables in the Markdow
320
320
Here are some points about working with tables in Markdown:
321
321
322
322
- Create each row on a separate line and end each row with a carriage return (CR) or line feed (LF).
323
-
- Create columns with hyphens (`-`) and the pipe symbol `|`, as in`|---|---|---|`.
323
+
- Create columns with hyphens `-` and the pipe symbol `|`, as in`|---|---|---|`.
324
324
- Define the column headers in the first row, as in`| First | Middle | Last |`.
325
-
- Define the column alignment (left, center, right) by using colons (`:`)in the second row, as in`|:--|:--:|--:|`.
325
+
- Define the column alignment (left, center, right) by using colons `:`in the second row, as in`|:--|:--:|--:|`.
326
326
- Escape the pipe symbol with a backslash `\|` when used in table text, as in`| Describe the pipe \| symbol. |`
327
-
- Add line breaks within a cell by using the HTML break tag (`<br/>`). This approach works within a wiki but not elsewhere.
327
+
- Add line breaks within a cell by using the HTML break tag `<br/>`. This approach works within a wiki but not elsewhere.
328
328
- Add a blank space before and after a work item or pull request mentioned in table text.
329
329
330
330
### Example: Create a table
@@ -451,7 +451,7 @@ Here are some points about working with links in Markdown:
451
451
452
452
- The standard Markdown syntax for a link is `[Link display text](Link path)`.
453
453
- In pull request comments and wikis, URLs that start with HTTP or HTTPS automatically format as links.
454
-
- If you use the hash`#`in other ways like color hex codes, you can avoid auto suggestions for work items by prefixing the hash`#` with a backslash (`\`).
454
+
- If you use the hashmark `#`in other ways like color hex codes, you can avoid auto suggestions for work items by prefixing the hashmark `#` with a backslash `\`.
455
455
- In Markdown files and widgets, you can create text hyperlinks for a URL by using the standard Markdown link syntax. The `Link path` can be relative or absolute.
456
456
457
457
The following example shows how to specify a relative link in Markdown, where the text renders as a hyperlink:
@@ -476,29 +476,40 @@ The following table lists the types of links supported for different Markdown sc
476
476
:::row:::
477
477
:::column span="":::
478
478
479
-
**Supported links for Welcome pages**
479
+
**Welcome pages**
480
+
481
+
- Relative path:
482
+
`[Display text](target.md)`
483
+
484
+
- Absolute path in Git:
485
+
`[Display text](/folder/target.md)`
480
486
481
-
- Relative path: `[Display text](target.md)`
482
-
- Absolute path in Git: `[Display text](/folder/target.md)`
483
-
- Absolute path in TFVC: `[Display text]($/project/folder/target.md)`
484
-
- URL: `[Display text](http://address.com)`
487
+
- Absolute path in TFVC:
488
+
`[Display text]($/project/folder/target.md)`
489
+
490
+
- URL:
491
+
`[Display text](http://address.com)`
485
492
486
493
:::column-end:::
487
494
488
495
:::column span="":::
489
496
490
-
**Supported links for the Markdown widget**
497
+
**Markdown widget**
491
498
492
-
- URL: `[Display text](http://address.com)`
499
+
- URL:
500
+
`[Display text](http://address.com)`
493
501
494
502
:::column-end:::
495
503
496
504
:::column span="":::
497
505
498
-
**Supported links for Wiki pages**
506
+
**Wiki pages**
507
+
508
+
- Absolute path of Wiki pages:
509
+
`[Display text](/parent-page/child-page)`
499
510
500
-
- Absolute path of Wiki pages: `[Display text](/parent-page/child-page)`
501
-
- URL: `[Display text](http://address.com)`
511
+
- URL:
512
+
`[Display text](http://address.com)`
502
513
503
514
:::column-end:::
504
515
:::row-end:::
@@ -509,10 +520,19 @@ The following table lists the types of links supported for different Markdown sc
509
520
510
521
Relative links to source control files are interpreted differently in a Welcome page versus a Markdown widget:
511
522
512
-
| Markdown | Link form | Example 1 | Example 2 |
513
-
|----------|-----------|-----------|-----------|
514
-
|**Welcome page**| Relative to root of source control repo where the Welcome page exists | _/BuildTemplates/AzureContinuousDeploy.11.xaml_ | _./page-2.md_ |
515
-
|**Markdown widget**| Relative to team project collection URL base | _/DefaultCollection/Fabrikam/_versionControl#path=$/TFVC-Welcome/BuildTemplates/AzureContinuousDeploy.11.xaml_ | _/DefaultCollection/Fabrikam/_versionControl#path=$/TFVC-Welcome/page-2.md_ |
523
+
#### Example: Welcome page relative links
524
+
525
+
Relative links in a Welcome page are relative to the root of the source control depository where the Welcome page exists. Here are some examples:
526
+
527
+
- _/BuildTemplates/AzureContinuousDeploy.11.xaml_
528
+
- _./page-2.md_
529
+
530
+
#### Markdown widget relative links
531
+
532
+
Relative links in a Markdown widget are relative to the team project collection URL base. Here are some examples:
@@ -523,21 +543,21 @@ When a Markdown file renders as HTML, the system assigns an anchor ID to each he
523
543
- Ignore (don't include) most special characters, such as `#`, `@`, `$`
524
544
- Ignore (don't include) most punctuation, such as `:`, `"`, `?`
525
545
526
-
You use the hash`#` character to link to the header in the document, as in`[Display text](#<header-anchor>)`.
546
+
You use the hashmark `#` to link to the header in the document, as in`[Display text](#<header-anchor>)`.
527
547
528
548
The following example shows a heading and a link its anchor ID:
529
549
530
550
```md
531
551
#### Team #1 : Release Wiki!
532
552
533
-
For more information, [Visit the Wiki](#team-1--release-wiki).
553
+
Welcome to the Release wiki. For more information, [Visit the Project Wiki](#team-1--release-wiki).
534
554
```
535
555
536
556
Here's the published view:
537
557
538
558
#### Team #1 : Release Wiki!
539
559
540
-
> For more information, [Visit the Wiki](#team-1--release-wiki).
560
+
Welcome to the Release wiki. For more information, [Visit the Project Wiki](#team-1--release-wiki).
541
561
542
562
You can also link to a heading in another Markdown file by specifying the file name with the anchor ID in the link:
543
563
@@ -636,27 +656,27 @@ A task is marked as completed by checking the task box in the list:
636
656
637
657
:::image type="content" source="media/markdown-guidance/checklist-pr-applied-check.png" alt-text="Screenshot that shows tasks marked as completed in the task list.":::
638
658
639
-
## Emojis
659
+
## Emoji reactions
640
660
641
-
Add emojis in pull requests and wiki files. You can use emojis to add character and react to comments in the request.
661
+
Add emoji reactions in pull requests and wiki files. You can use emoji reactions to add character and react to comments in the request.
642
662
643
-
Enter the name of an emotion or expression like `smile` and enclose the text within colon `:` characters. In the published view of the Markdown, your input is converted to the corresponding [emoji graphic](https://www.webpagefx.com/tools/emoji-cheat-sheet/). Markdown in Azure DevOps supports most emojis.
663
+
Enter the name of an emotion or expression like `smile` and enclose the text within colon `:` characters. In the published view of the Markdown, your input is converted to the corresponding [emoji graphic](https://www.webpagefx.com/tools/emoji-cheat-sheet/). Markdown in Azure DevOps supports most emoji graphics.
644
664
645
-
### Example: Add emojis in a pull request
665
+
### Example: Add emoji reactions in a pull request
646
666
647
-
The following example shows how to add emojis with Markdown in a pull request comment:
667
+
The following example shows how to add emoji reactions with Markdown in a pull request comment:
648
668
649
669
```md
650
670
The code review received :+1::+1: and the team is :smile:
651
671
```
652
672
653
-
Here's the published view of the emojis:
673
+
Here's the published view of the emoji reactions:
654
674
655
675
:::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.":::
656
676
657
-
### Example: Escape emojis in Markdown
677
+
### Example: Escape emoji syntax in Markdown
658
678
659
-
The following example shows how to escape emojis with the backslash `\` character in Markdown:
679
+
The following example shows how to escape emoji syntax with the backslash `\` character in Markdown:
660
680
661
681
```md
662
682
Markdown syntax for some emoji reactions:
@@ -689,19 +709,27 @@ The following Markdown uses the backslash `\` character to publish special chara
689
709
690
710
```md
691
711
\\\ Code comment
712
+
692
713
Show the **\_\_**underscores**\_\_**
714
+
693
715
\# Code comment and not a **Heading**
716
+
694
717
**\(** Include the **parentheses \)**
695
-
Show the __\*__asterisks__\*__, don't change to *italics*
718
+
719
+
Show the __\*__asterisks__\*__ and don't change to *italics*
696
720
```
697
721
698
722
Here's the published view of the Markdown:
699
723
700
724
\\\ Code comment
725
+
701
726
Show the **\_\_**underscores**\_\_**
727
+
702
728
\# Code comment and not a **Heading**
729
+
703
730
**\(** Include the **parentheses \)**
704
-
Show the __\*__asterisks__\*__, don't change to *italics*
731
+
732
+
Show the __\*__asterisks__\*__ and don't change to *italics*
705
733
706
734
> [!NOTE]
707
735
> For some Markdown, you can enter the HTML code `\` for the backslash rather than the character symbol `\`.
@@ -710,18 +738,67 @@ Show the __\*__asterisks__\*__, don't change to *italics*
710
738
711
739
## Attachments
712
740
713
-
Attach files in pull request comments and wiki pages. Attachments can help illustrate your point or provide details about your suggestions.
741
+
Attach files in pull request comments and wiki pages. Attachments can help illustrate your point or provide details about your suggestions. Attachments support the following file formats:
714
742
715
-
Attachments support the following file formats:
743
+
:::row:::
744
+
:::column span="1":::
745
+
**Attachment type**
746
+
:::column-end:::
747
+
:::column span="2":::
748
+
**File formats**
749
+
:::column-end:::
750
+
:::row-end:::
716
751
717
-
| Type | File formats |
718
-
|----------|--------------|
719
-
| **Code** | C# (_.cs_), Extensible Markup Language (_.xml_), JavaScript Object Notation (_.json_), Hypertext Markup Language (_.html_, _.htm_), Layer (_.lyr_), Windows PowerShell script (_.ps1_), Roshal Archive (_.rar_), Remote Desktop Connection (_.rdp_), Structured Query Language (_.sql_) <br> **Note**: Code attachments aren't supported in pull request comments. |
720
-
|**Compressed files**| ZIP (_.zip_), GZIP (_.gz_) |
721
-
|**Documents**| Markdown (_.md_), Microsoft Office Message (_.msg_), Microsoft Project (_.mpp_), Word (_.doc_, _.docx_), Excel (_.xls_, _.xlsx_, _.csv_), PowerPoint (_.ppt_, _.pptx_), Plain text (_.txt_), Portable Document Format (_.pdf_) |
Here's the published view of the characters in the Markdown file:
845
+
Here's the published view of the Greek characters:
769
846
770
847
:::image type="content" source="media/markdown-guidance/mathematical-notation-greek-characters.png" alt-text="Screenshot that shows the published view of the KaTex code snippet that lists Greek characters used in mathematical notation.":::
771
848
@@ -875,7 +952,7 @@ sequenceDiagram
875
952
876
953
Here's the published view of the sequence diagram:
877
954
878
-
:::image type="content" source="media/wiki/wiki-mermaid-sequence-diagram.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a sequence diagram and a preview of the published view.":::
955
+
:::image type="content" source="media/wiki/wiki-mermaid-sequence-diagram.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a sequence diagram and a preview of the published view." lightbox="media/wiki/wiki-mermaid-sequence-diagram.png":::
879
956
880
957
#### Example: Gantt chart
881
958
@@ -900,7 +977,7 @@ gantt
900
977
901
978
Here's the published view of the Gantt chart:
902
979
903
-
:::image type="content" source="media/wiki/wiki-mermaid-gantt-chart.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a Gantt chart and a preview of the published view.":::
980
+
:::image type="content" source="media/wiki/wiki-mermaid-gantt-chart.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a Gantt chart and a preview of the published view." lightbox="media/wiki/wiki-mermaid-gantt-chart.png":::
904
981
905
982
#### Example: Flowchart
906
983
@@ -911,7 +988,7 @@ The following example creates a flowchart with the `graph` type. The graph infor
911
988
> [!NOTE]
912
989
> Azure DevOps doesn't support the `flowchart` diagram type, the arrow `---->` syntax, or links to and from a `subgraph` diagram type.
:::image type="content" source="media/wiki/wiki-mermaid-flowchart.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a flowchart graph and a preview of the published view.":::
1002
+
:::image type="content" source="media/wiki/wiki-mermaid-flowchart.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a flowchart graph and a preview of the published view." lightbox="media/wiki/wiki-mermaid-flowchart.png":::
926
1003
927
1004
#### Example: Class diagram
928
1005
929
1006
The class diagram (type `classDiagram`) is the essential part of the object-oriented programming model. The diagram describes objects with their attributes and methods, and the inheritance between objects.
930
1007
931
1008
The following example shows how to add a class diagram to a wiki page:
932
1009
933
-
```
1010
+
```md
934
1011
:::mermaid
935
1012
classDiagram
936
1013
Creature <|-- Superman
@@ -958,15 +1035,15 @@ classDiagram
958
1035
959
1036
Here's the published view of the class diagram:
960
1037
961
-
:::image type="content" source="media/wiki/wiki-mermaid-class-diagram.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a class diagram and a preview of the published view.":::
1038
+
:::image type="content" source="media/wiki/wiki-mermaid-class-diagram.png" alt-text="Screenshot of the Mermaid Live Editor with the code for a class diagram and a preview of the published view." lightbox="media/wiki/wiki-mermaid-class-diagram.png":::
962
1039
963
1040
#### Example: State diagram
964
1041
965
1042
The state diagram (type `stateDiagram`) describes how system states can change when they transition from one state to another.
966
1043
967
1044
The following example shows how to add a state diagram to a wiki page. This example uses version 2 of the state diagram type (type `stateDiagram-v2`).
968
1045
969
-
```
1046
+
```md
970
1047
:::mermaid
971
1048
stateDiagram-v2
972
1049
[*] --> Active
@@ -996,7 +1073,7 @@ The user journey (type `journey`) diagram describes what steps are required to c
996
1073
997
1074
The following example shows how to add a user journey diagram to a wiki page:
998
1075
999
-
```
1076
+
```md
1000
1077
:::mermaid
1001
1078
journey
1002
1079
title Home office day
@@ -1024,7 +1101,7 @@ The pie chart (type `pie`) diagram helps to visualize the percentages of informa
1024
1101
1025
1102
The following example creates a pie chart with the title `Fishermen in countries`:
1026
1103
1027
-
```
1104
+
```md
1028
1105
:::mermaid
1029
1106
pie title Fishermen in countries
1030
1107
"Norway": 684
@@ -1043,7 +1120,7 @@ The requirements diagram (type `requirementDiagram`) creates a visualization of
1043
1120
1044
1121
The following example shows how to add a requirements diagram to a wiki page:
0 commit comments