檔案、小工具及 Wiki 的 Markdown 語法 - Azure DevOps

相关文章推荐

果断的凉茶 · 去年仅差1分；今年杭二扩两个班，学军扩一个班 ...· 2 月前 ·

温文尔雅的竹笋 · 董车日报｜理想 L9 新剧透：可连 ...· 1 年前 ·

光明磊落的高山 · 广阔大地上的灿烂繁花――2012年少数民族文 ...· 1 年前 ·

会搭讪的花卷 · 我的娘亲不好惹-🌈️包子漫畫· 1 年前 ·

聪明伶俐的遥控器 · 空调外机每天日晒雨淋，要不要加盖，很多人做错 ...· 1 年前 ·

若要檢視平臺可用的內容，請確定您從位於目錄上方的版本選取器中選取本文的正確版本。功能支援會因您是使用 Azure DevOps Services 還是內部部署版本的 Azure DevOps Server而有所不同，從 Team Foundation Server (TFS) 重新命名。
若要瞭解您使用的內部部署版本，請參閱查閱您的 Azure DevOps 平臺和版本

您可以在這裡找到在 Azure DevOps 功能中使用 Markdown 的一些基本 Markdown 語法指引和特定指引。您可以使用常見的 Markdown 慣例和 GitHub 類別延伸模組。

在正確的時間擁有正確的指引對於成功至關重要。使用 Markdown 將豐富的格式、表格和影像新增至您的專案頁面、讀我檔案、儀表板和提取要求批註。

如需 Wiki 頁面支援的語法，請參閱 Wiki Markdown 指引。

您可以使用 Markdown 在下欄區域中提供指引：

專案 Wiki

將程式碼發佈為 Wiki

已新增至儀表板的 Markdown 小工具

使用標題為您的註解建立結構。標題可切割較長的註解，讓其更容易閱讀。

以雜湊字元 # 作為行的開頭來設定標題。使用子標題來組織您的備註，方法是啟動包含更杜哈希字元的行， #### 例如。您最多可以使用六個標題層級。

# This is a H1 header
## This is a H2 header
### This is a H3 header
#### This is a H4 header
##### This is a H5 header
段落和分行符號
支援于：完成的定義 |Markdown 小工具 |提取要求 |讀我檔案 |Wiki
將文字分成段落或分行符號，讓您的文字更容易閱讀。
在提取要求批註中，選取 Enter 以插入分行符號，並在新行上開始文字。
範例 - 提取要求批註：
Add lines between your text with the **Enter** key.
Your text gets better spaced and makes it easier to read.
使用 Enter 鍵在文字之間新增行。
您的文字會獲得較佳的間距，讓您更容易閱讀。
Markdown 檔案或小工具
在 Markdown 檔案或小工具中，于分行符號之前輸入兩個空格，然後選取 Enter 以開始新的段落。
範例 - Markdown 檔案或小工具：
Add two spaces before the end of the line, and then select **Enter**.(space, space, Enter)
A space gets added in between paragraphs.
在行尾加上兩個空格，然後選取 Enter。
段落之間會加入空格。
支援于：完成的定義 |Markdown 小工具 |提取要求 |讀我檔案 |Wiki
為先前的批註或文字加上引號，以設定批註或文字的內容。
在文字前面加上 > 單行文字。 使用許多 > 字元來巢狀加上引號的文字。
使用跨多行的相同層級 > 來引述文字行區塊。
> Single line quote
>> Nested quote
>> multiple line
>> quote
支援于：完成的定義 |Markdown 小工具 |提取要求 |讀我檔案 |Wiki
若要新增水準規則，請新增一連串虛 --- 線 的線條。 包含 --- 的行上方這一行必須是空白。
above
below
強調 (粗體、斜體、刪除線)
支援于：完成的定義 |Markdown 小工具 |提取要求 |讀我檔案 |Wiki
您可以對文字套用粗體、斜體或刪除線來強調文字。
若要套用斜體：以星號 * 或底線 _ 括住文字。
若要套用粗體：以兩個星號 ** 括住文字。
若要套用刪除線：以兩個波狀符號字元 ~~ 括住文字。
結合這些元素以將強調套用至文字。
沒有支援底線文字的 Markdown 語法。 在 Wiki 頁面中，您可以使用 HTML <u> 標籤來產生加底線的文字。 例如， <u>underlined text</u> 會產生 加底線的文字。
沒有支援底線文字的 Markdown 語法。 在 TFS 2018.2 和更新版本中的 Wiki 頁面中，您可以使用 HTML <u> 標籤來產生加底線的文字。 例如， <u>underlined text</u> 會產生 加底線的文字。
Use _emphasis_ in comments to express **strong** opinions and point out ~~corrections~~  
**_Bold, italicized text_**  
**~~Bold, strike-through text~~**
Use emphasis in comments to express strong opinions and point out corrections

粗體、斜體文字粗體、刪除線文字
程式碼醒目提示
支援于：提取要求 |讀我檔案 |Wiki
使用程式碼醒目提示區塊醒目提示建議的程式碼區段。
若要指出程式碼範圍，請在區塊的開頭和結尾處，以三個倒引號引號 (```) 換行。 若要指示程式碼內嵌，請將它包裝成單引號引號 (`) 。
在 Markdown 小工具內輸入的程式碼醒目提示會將程式碼轉譯為純文字預先格式化的文字。
sudo npm install vsoagent-installer -g  
sudo npm install vsoagent-installer -g
To install the Microsoft Cross Platform Build & Release Agent, run the following: `$ sudo npm install vsoagent-installer -g`.
若要安裝 Microsoft 跨平臺組建 & 發行代理程式，請執行下列命令： $ sudo npm install vsoagent-installer -g 。
在 Markdown 檔案中，行開頭有四個空格的文字會自動轉換成程式碼區塊。
設定程式碼區塊的語言識別項，以在 highlightjs 9.10.0 版中啟用任何支援語言的語法醒目提示。
``` language
其他範例：
``` js
const count = records.length;
const count = records.length;
``` csharp
Console.WriteLine("Hello, World!");
Console.WriteLine("Hello, World!");
Tables
支援于：Markdown 小工具 |提取要求 |讀我檔案 |Wiki
使用資料表來整理結構化的資料。 資料表特別適合用來描述函式參數、物件方法，以及具有清楚描述對應名稱的其他資料。 您可以在提取要求、Wiki 和 Markdown 檔案中格式化資料表，例如 README 檔案和 Markdown 小工具。
將每個資料表資料列放在自己的行上。
使用管道字元 | 分隔表格儲存格。
若要在資料表中使用管道字元，您必須使用反斜線 \| 逸出 。
資料表的前兩行會設定資料行標頭，以及資料表中元素的對齊方式。
在分割資料表的標頭和本文時，請使用冒號 (:) ，以指定 (左、置中、右) 的資料行對齊方式。
若要啟動新行，請使用 HTML 中斷標籤 (<br/>)  (在 Wiki 內運作，但不適用於其他位置) 。
請務必使用 CR 或 LF 來結束每一個資料列。
您必須在工作專案或提取要求之前或之後輸入空格， (PR) 在表格儲存格內提及。
| Heading 1 | Heading 2 | Heading 3 |  
|-----------|:-----------:|-----------:|  
| Cell A1 | Cell A2 | Cell A3 |  
| Cell B1 | Cell B2 | Cell B3<br/>second line of text |  
Heading 2
Heading 3
Lists
支援于：完成的定義 |Markdown 小工具 |提取要求 |讀我檔案 |Wiki
使用清單來整理相關的項目。 您可以新增具有數位的已排序清單，或只包含專案符號的未排序清單。
排序清單中每個清單項目的開頭都是數字，後面接著英文句號。 未排序清單會以 - 作為開頭。 每個清單項目都以新的一行開始。 在 Markdown 檔案或小工具中，于分行符號之前輸入兩個空格以開始新的段落，或連續輸入兩個分行符號以開始新的段落。
排序或編號清單
1. First item.
1. Second item.
1. Third item.
First item.
Second item.
Third item.
項目符號清單
- Item 1
- Item 2
- Item 3
1. First item.
   - Item 1
   - Item 2
   - Item 3
1. Second item.
   - Nested item 1
      - Further nested item 1
      - Further nested item 2
      - Further nested item 3
   - Nested item 2
   - Nested item 3
First item.
Second item.
Nested item 1
進一步的巢狀專案 1
進一步的巢狀專案 2
進一步的巢狀專案 3
Nested item 2
Nested item 3
支援于：完成的定義 |Markdown 小工具 |提取要求 |讀我檔案 |Wiki
在提取要求批註和 Wiki 中，HTTP 和 HTTPS URL 會自動格式化為連結。 您可以輸入 # 索引鍵和工作專案識別碼，然後從清單中選擇工作專案，以連結至工作專案。
使用反斜線 () \ 前置詞 # ，以避免工作專案的自動建議。 如果您想要 # 用於色彩十六進位代碼，此動作會很有用。
在 Markdown 檔案和小工具中，您可以使用標準 Markdown 連結語法來設定 URL 的文字超連結：
[Link Text](Link URL)
當您連結到相同 Git 或 TFVC 存放庫中的另一個 Markdown 頁面時，連結目標可以是存放庫中的相對路徑或絕對路徑。
歡迎頁面的支援連結：
相對路徑： [text to display](target.md)
Git 中的絕對路徑： [text to display](/folder/target.md)
TFVC 中的絕對路徑： [text to display]($/project/folder/target.md)
URL： [text to display](http://address.com)
Markdown 小工具支援的連結：
URL： [text to display](http://address.com)  
Wiki 支援的連結：
Wiki 頁面的絕對路徑： [text to display](/parent-page/child-page) 
URL： [text to display](http://address.com)  
2017.1 和更新版本不支援檔案 file:// 共用上檔的連結。 基於安全性目的，已實作這項限制。
如需如何從歡迎頁面或 Markdown 小工具指定相對連結的資訊，請參閱 原始檔控制相對連結。
[C# language reference](/dotnet/csharp/language-reference/)
C# 語言參考
原始檔控制相對連結
原始檔控制檔案的連結會根據您是否在歡迎頁面或 Markdown 小工具中指定，以不同的方式解譯。 系統會解譯相對連結，如下所示：
歡迎頁面： 相對於歡迎頁面所在的原始檔控制存放庫根目錄
Markdown 小工具： 相對於 Team 專案集合 URL 基底
Markdown 小工具對等專案
/BuildTemplates/AzureContinuousDeploy.11.xaml
/DefaultCollection/Fabrikam Fiber/_versionControl#path=$/Tfvc Welcome/BuildTemplates/AzureContinuousDeploy.11.xaml
./page-2.md
/DefaultCollection/Fabrikam Fiber/_versionControl#path=$/Tfvc Welcome/page-2.md
在 Markdown 檔案中，錨點識別碼會在轉譯為 HTML 時指派給所有標題。 識別碼為標題文字，並以連字號 (-) 取代空格且全部都是小寫。 一般而言，適用下列慣例：
會忽略檔案名內的標點符號和前置空白字元
大寫字母會轉換成小寫字母
字母之間的空格會轉換成虛線 () 
###Link to a heading in the page
某節錨點連結的語法...
[Link to a heading in the page](#link-to-a-heading-in-the-page)
識別碼全都是小寫，而且連結區分大小寫，因此請務必使用小寫，即使標題本身使用大寫也一樣。
您也可以參考另一個 Markdown 檔案內的標題：
[text to display](./target.md#heading-id)  
在 Wiki 中，您也可以在另一個頁面中參考標題：[text to display](/page-name#section-name)
支援于：Markdown 小工具 |提取要求 |讀我檔案 |Wiki
若要醒目提示問題或讓專案更有趣，您可以將影像和動畫 GIF 新增至提取要求的下列層面：
Markdown 檔案
Wiki 頁面
使用下列語法來新增影像：
![Text](URL) 括弧中的文字描述連結的影像和 URL 指向影像位置。
![Illustration to use for new users](https://azurecomcdn.azureedge.net/cvt-779fa2985e70b1ef1c34d319b505f7b4417add09948df4c5b81db2a9bad966e5/images/page/services/devops/hero-images/index-hero.jpg)
影像檔的路徑可以是 Git 或 TFVC 中的相對路徑或絕對路徑，就像連結中另一個 Markdown 檔案的路徑一樣。
相對路徑： ![Image alt text](./image.png)
Git 中的絕對路徑： ![Image alt text](/media/markdown-guidance/image.png)
TFVC 中的絕對路徑： ![Image alt text]($/project/folder/media/markdown-guidance/image.png)
調整影像大小： IMAGE_URL =WIDTHxHEIGHT
請務必在等號之前包含空格。
範例： ![Image alt text]($/project/folder/media/markdown-guidance/image.png =500x250)
您也可以藉由離開 HEIGHT 值來指定 WIDTH： IMAGE_URL =WIDTHx
檢查清單或工作清單
支援：提取要求 |Wiki
輕量型工作清單是在 PR 描述或 Wiki 頁面中，以提取要求建立者或檢閱者身分追蹤您的作業進度的絕佳方式。 選取 Markdown 工具列以開始使用，或將格式套用至選取的文字。
您可以使用 [ ] 或 [x] 來支援檢查清單。 在檢查清單前面加上 -<space> 或 1.<space> (任何數位) 。
範例 - 將工作清單 Markdown 套用至醒目提示的清單
若要選取方塊來將專案標示為已完成，您必須在新增工作清單之後手動編輯 Markdown 並修改語法。
範例 - 將清單格式化為工作清單
- [ ] A  
- [ ] B  
- [ ] C  
- [x] A  
- [x] B  
- [x] C  
不支援表格儲存格內的檢查清單。
Emoji
支援：提取要求 |Wiki
在提取要求批註和 Wiki 頁面中，您可以使用 emoji 來新增字元，並回應要求中的批註。 輸入您覺得以字元括住 : 的內容，以在文字中取得相符的 emoji。 我們支援 一組完整的 Emoji。
:smile:
:angry:
若要逸出 emoji，請使用 ' 字元括住它們。
`:smile:` `:)` `:angry:`
:smile: :) :angry:
忽略或逸出 Markdown 語法以輸入特定或常值字元
支援于：完成的定義 |Markdown 小工具 |提取要求 |讀我檔案 |Wiki
範例/附註
支援：提取要求 |Wiki
在提取要求批註和 Wiki 頁面中，您可以附加檔案來說明您的點，或提供更詳細的建議背後的原因。 若要附加檔案，請將它拖放到批註欄位中，或 Wiki 頁面編輯體驗。 您也可以在批註方塊右上方，或從 Wiki 頁面中的格式窗格選取 紙夾 。
如果您的剪貼簿中有影像，您可以從剪貼簿貼到批註方塊或 Wiki 頁面中，然後直接轉譯到您的批註或 Wiki 頁面。
附加非影像檔會建立批註中檔案的連結。 更新括弧之間的描述文字，以變更連結中顯示的文字。
附加的影像檔會直接轉譯至您的批註或 Wiki 頁面。 使用附件儲存或更新您的批註或 Wiki 頁面。 然後，您可以看到附加的映射，然後選取連結以下載附加的檔案。
附件支援下列檔案格式：
CS (.cs) 、Extensible Markup Language (.xml) 、JavaScript 物件標記法 (.json) 、 超文字標記語言 (.html、.htm) 層 (.lyr) 、Windows PowerShell腳本 (.ps1) 、Roshal 封存 (.rar) 、遠端桌面連線 (.rdp) 、結構化查詢語言 (SQL)  (.sql) -注意：PR 批註中不允許程式碼附件
ZIP (.zip) 和 GZIP (.gz) 
Markdown (.md) ， Microsoft Office Message (.msg) 、Microsoft Project (.mpp) 、Word (.doc 和 .docx) 、Excel (.xls、.xlsx 和 .csv) ，以及 Powerpoint (.ppt 和 .pptx) 、文字檔 (.txt) 和 PDF (.pdf) 
PNG (.png) 、GIF (.gif) 、JPEG (.jpeg 和 .jpg) 、圖示 (.ico) 
Visio
VSD (.vsd 和 .vsdx) 
MOV (.mov) 、MP4 (.mp4) 
範例：希臘文字元
\alpha, \beta, \gamma, \delta, \epsilon, \zeta, \eta, \theta, \kappa, \lambda, \mu, \nu, \omicron, \pi, \rho, \sigma, \tau, \upsilon, \phi, ...
$\Gamma,  \Delta,  \Theta, \Lambda, \Xi, \Pi, \Sigma, \Upsilon, \Phi, \Psi, \Omega$
範例：代數標記法
 $Area of a circle is $\pi r^2$ And, the area of a triangle is: A_{triangle}=\frac{1}{2}({b}\cdot{h}) 範例：總和和整數 \sum_{i=1}^{10} t_i \int_0^\infty \mathrm{e}^{-x}\,\mathrm{d}x 專案頁面或歡迎頁面 Markdown 小工具 Widget 目錄 新增和編輯 Wiki 頁面$