Skip to content

Commit 4611090

Browse files
committed
edits
1 parent 977d9cf commit 4611090

File tree

3 files changed

+132
-55
lines changed

3 files changed

+132
-55
lines changed

docs/project/wiki/markdown-guidance.md

Lines changed: 132 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The following table outlines the feature support for different Markdown elements
5454
| [Links](#links) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
5555
| [Images](#images) | | ✔️ | ✔️ | ✔️ | ✔️ |
5656
| [Checklist or task list](#checklists) | | | ✔️ | | ✔️ |
57-
| [Emojis](#emojis) | | | ✔️ | | ✔️ |
57+
| [Emojis](#emoji-reactions) | | | ✔️ | | ✔️ |
5858
| [Ignore or escape Markdown](#ignore) | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ |
5959
| [Attachments](#attachments) | | | ✔️ | | ✔️ |
6060
| [Mathematical notation](#math-notation) | | | ✔️ | | ✔️ |
@@ -265,7 +265,7 @@ The following examples show how to identify a text block as JavaScript or C#. Yo
265265
266266
**JavaScript**
267267
268-
```
268+
```Code Snippet
269269
<!-- ```js - Three backticks and identifier 'js' -->
270270
const count = records.length;
271271
<!-- ``` - Three backticks -->
@@ -279,7 +279,7 @@ const count = records.length;
279279
280280
**C#**
281281
282-
```
282+
```Code Snippet
283283
<!-- ```csharp - Three backticks and identifier 'csharp' -->
284284
Console.WriteLine("Hello, World!");
285285
<!-- ``` - Three backticks -->
@@ -320,11 +320,11 @@ Organize structured data with Markdown tables. You can add tables in the Markdow
320320
Here are some points about working with tables in Markdown:
321321
322322
- 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 `|---|---|---|`.
324324
- 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 `|:--|:--:|--:|`.
326326
- 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.
328328
- Add a blank space before and after a work item or pull request mentioned in table text.
329329
330330
### Example: Create a table
@@ -451,7 +451,7 @@ Here are some points about working with links in Markdown:
451451
452452
- The standard Markdown syntax for a link is `[Link display text](Link path)`.
453453
- 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 hash mark `#` in other ways like color hex codes, you can avoid auto suggestions for work items by prefixing the hash mark `#` with a backslash `\`.
455455
- 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.
456456
457457
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
476476
:::row:::
477477
:::column span="":::
478478
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)`
480486
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)`
485492
486493
:::column-end:::
487494
488495
:::column span="":::
489496
490-
**Supported links for the Markdown widget**
497+
**Markdown widget**
491498
492-
- URL: `[Display text](http://address.com)`
499+
- URL:
500+
`[Display text](http://address.com)`
493501
494502
:::column-end:::
495503
496504
:::column span="":::
497505
498-
**Supported links for Wiki pages**
506+
**Wiki pages**
507+
508+
- Absolute path of Wiki pages:
509+
`[Display text](/parent-page/child-page)`
499510
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)`
502513
503514
:::column-end:::
504515
:::row-end:::
@@ -509,10 +520,19 @@ The following table lists the types of links supported for different Markdown sc
509520
510521
Relative links to source control files are interpreted differently in a Welcome page versus a Markdown widget:
511522
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:
533+
534+
- _/DefaultCollection/Fabrikam/_versionControl#path=$/TFVC-Welcome/BuildTemplates/AzureContinuousDeploy.11.xaml_
535+
- _/DefaultCollection/Fabrikam/_versionControl#path=$/TFVC-Welcome/page-2.md_
516536
517537
### Anchor links
518538
@@ -523,21 +543,21 @@ When a Markdown file renders as HTML, the system assigns an anchor ID to each he
523543
- Ignore (don't include) most special characters, such as `#`, `@`, `$`
524544
- Ignore (don't include) most punctuation, such as `:`, `"`, `?`
525545
526-
You use the hash `#` character to link to the header in the document, as in `[Display text](#<header-anchor>)`.
546+
You use the hash mark `#` to link to the header in the document, as in `[Display text](#<header-anchor>)`.
527547
528548
The following example shows a heading and a link its anchor ID:
529549
530550
```md
531551
#### Team #1 : Release Wiki!
532552
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).
534554
```
535555
536556
Here's the published view:
537557
538558
#### Team #1 : Release Wiki!
539559
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).
541561
542562
You can also link to a heading in another Markdown file by specifying the file name with the anchor ID in the link:
543563
@@ -636,27 +656,27 @@ A task is marked as completed by checking the task box in the list:
636656
637657
:::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.":::
638658
639-
## Emojis
659+
## Emoji reactions
640660
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.
642662
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.
644664
645-
### Example: Add emojis in a pull request
665+
### Example: Add emoji reactions in a pull request
646666
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:
648668
649669
```md
650670
The code review received :+1::+1: and the team is :smile:
651671
```
652672
653-
Here's the published view of the emojis:
673+
Here's the published view of the emoji reactions:
654674
655675
:::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.":::
656676
657-
### Example: Escape emojis in Markdown
677+
### Example: Escape emoji syntax in Markdown
658678
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:
660680
661681
```md
662682
Markdown syntax for some emoji reactions:
@@ -689,19 +709,27 @@ The following Markdown uses the backslash `\` character to publish special chara
689709
690710
```md
691711
\\\ Code comment
712+
692713
Show the **\_\_**underscores**\_\_**
714+
693715
\# Code comment and not a **Heading**
716+
694717
**\(** Include the **parentheses \)**
695-
Show the __\*__asterisks__\*__, don't change to *italics*
718+
719+
Show the __\*__asterisks__\*__ and don't change to *italics*
696720
```
697721
698722
Here's the published view of the Markdown:
699723
700724
\\\ Code comment
725+
701726
Show the **\_\_**underscores**\_\_**
727+
702728
\# Code comment and not a **Heading**
729+
703730
**\(** Include the **parentheses \)**
704-
Show the __\*__asterisks__\*__, don't change to *italics*
731+
732+
Show the __\*__asterisks__\*__ and don't change to *italics*
705733
706734
> [!NOTE]
707735
> For some Markdown, you can enter the HTML code `&#92;` for the backslash rather than the character symbol `\`.
@@ -710,18 +738,67 @@ Show the __\*__asterisks__\*__, don't change to *italics*
710738
711739
## Attachments
712740
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:
714742
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:::
716751
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_) |
722-
| **Images** | PNG (_.png_), GIF (_.gif_), JPEG (_.jpeg_, _.jpg_), Icons (_.ico_) |
723-
| **Visio** | VSD (_.vsd_, _.vsdx_) |
724-
| **Video** | MOV (_.mov_), MP4 (_.mp4_) |
752+
:::row:::
753+
:::column span="1":::
754+
**Code**
755+
:::column-end:::
756+
:::column span="2":::
757+
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_)
758+
759+
**Note**: Code attachments aren't supported in pull request comments.
760+
:::column-end:::
761+
:::row-end:::
762+
:::row:::
763+
:::column span="1":::
764+
**Compressed files**
765+
:::column-end:::
766+
:::column span="2":::
767+
ZIP (_.zip_), GZIP (_.gz_)
768+
:::column-end:::
769+
:::row-end:::
770+
:::row:::
771+
:::column span="1":::
772+
**Documents**
773+
:::column-end:::
774+
:::column span="2":::
775+
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_)
776+
:::column-end:::
777+
:::row-end:::
778+
:::row:::
779+
:::column span="1":::
780+
**Images**
781+
:::column-end:::
782+
:::column span="2":::
783+
PNG (_.png_), GIF (_.gif_), JPEG (_.jpeg_, _.jpg_), Icons (_.ico_)
784+
:::column-end:::
785+
:::row-end:::
786+
:::row:::
787+
:::column span="1":::
788+
**Visio**
789+
:::column-end:::
790+
:::column span="2":::
791+
VSD (_.vsd_, _.vsdx_)
792+
:::column-end:::
793+
:::row-end:::
794+
:::row:::
795+
:::column span="1":::
796+
**Video**
797+
:::column-end:::
798+
:::column span="2":::
799+
MOV (_.mov_), MP4 (_.mp4_)
800+
:::column-end:::
801+
:::row-end:::
725802
726803
> [!NOTE]
727804
> Not all file formats are supported as attachments in pull request comments, such as Microsoft Office Message (.msg) files.
@@ -765,7 +842,7 @@ $
765842
$\Gamma, \Delta, \Theta, \Lambda, \Xi, \Pi, \Sigma, \Upsilon, \Phi, \Psi, \Omega$
766843
```
767844
768-
Here's the published view of the characters in the Markdown file:
845+
Here's the published view of the Greek characters:
769846
770847
:::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.":::
771848
@@ -875,7 +952,7 @@ sequenceDiagram
875952
876953
Here's the published view of the sequence diagram:
877954
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":::
879956
880957
#### Example: Gantt chart
881958
@@ -900,7 +977,7 @@ gantt
900977
901978
Here's the published view of the Gantt chart:
902979
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":::
904981
905982
#### Example: Flowchart
906983
@@ -911,7 +988,7 @@ The following example creates a flowchart with the `graph` type. The graph infor
911988
> [!NOTE]
912989
> Azure DevOps doesn't support the `flowchart` diagram type, the arrow `---->` syntax, or links to and from a `subgraph` diagram type.
913990
914-
```
991+
```md
915992
:::mermaid
916993
graph LR;
917994
A[Hard edge] -->|Link text| B(Round edge) --> C{Decision}
@@ -922,15 +999,15 @@ graph LR;
922999
9231000
Here's the published view of the flowchart graph:
9241001
925-
:::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":::
9261003
9271004
#### Example: Class diagram
9281005
9291006
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.
9301007
9311008
The following example shows how to add a class diagram to a wiki page:
9321009
933-
```
1010+
```md
9341011
:::mermaid
9351012
classDiagram
9361013
Creature <|-- Superman
@@ -958,15 +1035,15 @@ classDiagram
9581035
9591036
Here's the published view of the class diagram:
9601037
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":::
9621039
9631040
#### Example: State diagram
9641041
9651042
The state diagram (type `stateDiagram`) describes how system states can change when they transition from one state to another.
9661043
9671044
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`).
9681045
969-
```
1046+
```md
9701047
:::mermaid
9711048
stateDiagram-v2
9721049
[*] --> Active
@@ -996,7 +1073,7 @@ The user journey (type `journey`) diagram describes what steps are required to c
9961073
9971074
The following example shows how to add a user journey diagram to a wiki page:
9981075
999-
```
1076+
```md
10001077
:::mermaid
10011078
journey
10021079
title Home office day
@@ -1024,7 +1101,7 @@ The pie chart (type `pie`) diagram helps to visualize the percentages of informa
10241101
10251102
The following example creates a pie chart with the title `Fishermen in countries`:
10261103
1027-
```
1104+
```md
10281105
:::mermaid
10291106
pie title Fishermen in countries
10301107
"Norway" : 684
@@ -1043,7 +1120,7 @@ The requirements diagram (type `requirementDiagram`) creates a visualization of
10431120
10441121
The following example shows how to add a requirements diagram to a wiki page:
10451122
1046-
```
1123+
```md
10471124
:::mermaid
10481125
requirementDiagram
10491126
requirement development_req {
121 Bytes
Loading
3.76 KB
Loading

0 commit comments

Comments
 (0)