文件、小组件和 Wiki 的 Markdown 语法 - Azure DevOps

link之家

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

相关文章推荐

重感情的水煮肉 · 表现符合预期 ...· 1 年前 ·

风流倜傥的作业本 · 【警示信息】历史上六月发生的危险化学品事故_ ...· 1 年前 ·

温暖的煎饼 · 吉林普法网· 1 年前 ·

爱吹牛的香烟 · python条件赋值判断语句语法_pytho ...· 2 年前 ·

深情的鸵鸟 · 人岛 TT ...· 2 年前 ·

若要查看可用于你的平台的内容，请确保从目录上方的版本选择器中选择本文的正确版本。功能支持会有所不同，具体取决于你使用的是 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 版本 v9.10.0 中为任何受支持的语言启用语法突出显示。
``` language
更多示例：
``` js
const count = records.length;
const count = records.length;
``` csharp
Console.WriteLine("Hello, World!");
Console.WriteLine("Hello, World!");
支持：Markdown 小组件 |拉取请求 |自述文件 |Wiki
使用表组织结构化的数据。 表对于描述函数参数、对象方法和其他具有明确名称的描述映射的数据特别有用。 可以在拉取请求、Wiki 和 Markdown 文件（如自述文件和 Markdown 小组件）中设置表格的格式。
将每个表格行放在其自己的行上。
使用管道字符 |分隔表单元格。
若要在表中使用管道字符，必须使用反斜杠 进行转义 \|。
表中的前两行设置列标题和表中元素的对齐方式。
在分隔表的标题和正文时，使用冒号 (:) ，以指定列对齐方式 (左、中、右) 。
若要开始新行，请使用 HTML break 标记 (<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
支持：完成的定义 |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 项
第 2 项
第 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.
第 1 项
第 2 项
第 3 项
Second item.
Nested item 1
其他嵌套项 1
其他嵌套项 2
其他嵌套项 3
Nested item 2
Nested item 3
支持：完成的定义 |Markdown 小组件 |拉取请求 |自述文件 |Wiki
在拉取请求注释和 Wiki 中，HTTP 和 HTTPS URL 会自动格式化为链接。 可以通过输入 # 键和工作项 ID，然后从列表中选择工作项来链接到工作项。
通过在) 加上反斜杠 (\ 前缀#来避免工作项的自动建议。 如果要将 # 用于颜色十六进制代码，此操作可能很有用。
在 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 小组件： 相对于团队项目集合 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 文件中，定位点 ID 在呈现为 HTML 时分配给所有标题。 该 ID 为标题文本，空格替换为短划线 (-) 且字母全小写。 通常，以下约定适用：
忽略文件名中的标点符号和前导空格
大写字母转换为小写字母
字母之间的空格转换为短划线 () 
###Link to a heading in the page
到某部分的定位标记链接的语法...
[Link to a heading in the page](#link-to-a-heading-in-the-page)
ID 全部为小写，链接区分大小写，因此请确保使用小写，即使标题本身使用大写。
还可以引用另一个 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  
不支持表单元格中的清单。
支持：拉取请求 |Wiki
在拉取请求评论和 Wiki 网页中，可以使用表情符号添加字符并响应请求中的注释。 输入被字符包围 : 的感觉，以在文本中获取匹配的表情符号。 我们支持 整套表情符号。
:smile:
:angry:
若要转义表情符号，请使用 字符将其括起来。
`:smile:` `:)` `:angry:`
:smile: :) :angry:
忽略或转义 Markdown 语法以输入特定或文本字符
支持：完成的定义 |Markdown 小组件 |拉取请求 |自述文件 |Wiki
示例/说明
Attachments
支持：拉取请求 |Wiki
在拉取请求评论和 Wiki 网页中，你可以附加文件来说明你的观点或给出建议背后的更详细的推理。 若要附加文件，请将其拖放到注释字段或 Wiki 页面编辑体验中。 还可以选择注释框右上角的回形针，或者从 Wiki 页面的格式窗格中选择 回形针 。
如果剪贴板中有图像，则可以将其从剪贴板粘贴到批注框或 Wiki 页面，然后直接呈现到批注或 Wiki 页面中。
附加非图像文件会在注释中创建指向该文件的链接。 更新括号之间的说明文本，以更改链接中显示的文本。
附加的图像文件直接呈现到您的评论或 Wiki 页面中。 使用附件保存或更新评论或 Wiki 页面。 然后，可以查看附加的图像并选择链接以下载附加的文件。
附件支持以下文件格式：
CS (.cs) 、可扩展标记语言 (.xml) 、JavaScript 对象表示法 (.json) ， 超文本标记语言 (.html、.htm) 、Layer (.lyr) 、Windows PowerShell脚本 (.ps1) 、Roshal 存档 (.rar) 、远程桌面连接 (.rdp) 、结构化查询语言 (.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}) 示例：Sums 和 Integrals \sum_{i=1}^{10} t_i \int_0^\infty \mathrm{e}^{-x}\,\mathrm{d}x 项目页或欢迎页 Markdown 小组件 小组件目录 添加和编辑 Wiki 页面$