Wiki 的 Markdown 语法 - Azure DevOps

若要创建目录，请添加 [[_TOC_]]。添加标记且页面上至少有一个标题时，将生成 TOC。

[_TOC_]] 可以放置在页面中的任意位置来呈现目录。 TOC 仅考虑 Markdown 标题 (HTML 标题标记不被视为) 。

将所有 HTML 和 Markdown 标记从标题中删除，同时将其添加到 TOC 块中。请参阅以下示例，了解向标题添加粗体和斜体时 TOC 如何呈现。

在 TOC 中的格式设置中保持一致性。

标记 [[_TOC_]] 区分大小写。例如，[[_toc_]] 可能不会呈现 TOC。此外，仅呈现 [[_TOC_]] 的第一个实例，其余实例将被忽略。

添加子页表

将子页的目录 (TOSP) 添加到 Wiki 页面。此表包含指向显示子页表的页面下的所有子页的链接。

可以通过手动插入特殊标记 [[_TOSP_]] 或通过从“ 更多选项 ”菜单中选择来添加子页表。仅使用第一个 [[_TOSP_]] 标记来创建子页的表。

并非关系图类型的以下链接内容中的所有语法在 Azure DevOps 中都有效。例如，我们不支持大多数 HTML 标记、Font Awesome、


    flowchart

语法 (


    graph

改为) 或 LongArrow


    ---->

。

Internet Explorer 浏览器中不支持 Mermaid。

如果遇到“不支持的图表类型”，则由于常用的部署方案，该功能可能尚未在组织中提供。

Wiki 支持以下美人鱼图类型：

要求关系图

有关详细信息，请参阅开发者社区中的 Mermaid 发行说明和活动请求。

若要将美人鱼图添加到 Wiki 页面，请使用以下语法：

::: mermaid
<mermaid diagram syntax>
序列图示例
序列图是一个交互图，显示进程如何相互操作以及按何种顺序运行。
::: mermaid
sequenceDiagram
    Christie->>Josh: Hello Josh, how are you?
    Josh-->>Christie: Great!
    Christie->>Josh: See you later!
甘特图示例
甘特图将每个计划任务记录为一个从左到右延伸的连续条。 x 轴表示时间，y 记录不同的任务及其完成顺序。
当排除特定于任务的日期、日期或集合时，甘特图通过向右扩展相等的天数（而不是在任务内创建间隙）来适应这些更改。
::: mermaid
gantt
    title A Gantt chart
    dateFormat YYYY-MM-DD
    excludes 2022-03-16,2022-03-18,2022-03-19
    section Section
    A task          :a1, 2022-03-07, 7d
    Another task    :after a1 , 5d
流程图示例
流程图由节点、几何形状和边缘以及箭头或线条组成。
以下示例演示使用 graph 而不是 flowchart的流程图。
我们不支持 ----> 或 flowchart 语法，也不支持指向 和 来自 subgraph的链接。
:::mermaid
graph LR;
    A[Hard edge] -->|Link text| B(Round edge) --> C{Decision}
    C -->|One| D[Result one]
    C -->|Two| E[Result two]
类图是面向对象的建模main一部分。 该图描述了对象及其属性、方法和它们之间的继承。
:::mermaid
classDiagram
    Creature <|-- Superman
    Creature <|-- Vampire
    Creature <|-- Diavolo
    Creature: +int size
    Creature: +int weight
    Creature: +isBenign()
    Creature: +power()
    class Superman{
        +String currentName
        +fly()
        +heal()
    class Vampire{
        -int age
        -canBite()
    class Diavolo{
        +bool is_serving
        +heat()
状态图示例
状态图用于描述系统状态如何从一个更改为另一个。
:::mermaid
stateDiagram-v2
    [*] --> Active
    state Active {
        [*] --> NumLockOff
        NumLockOff --> NumLockOn : EvNumLockPressed
        NumLockOn --> NumLockOff : EvNumLockPressed
        [*] --> CapsLockOff
        CapsLockOff --> CapsLockOn : EvCapsLockPressed
        CapsLockOn --> CapsLockOff : EvCapsLockPressed
        [*] --> ScrollLockOff
        ScrollLockOff --> ScrollLockOn : EvScrollLockPressed
        ScrollLockOn --> ScrollLockOff : EvScrollLockPressed
用户旅程示例
用户旅程关系图描述了完成某些更高级别的操作或任务所需的步骤。
:::mermaid
journey
    title Home office day
    section Go to work
      Wake up: 1: Me, Dog
      Take shower: 2: Me
      Go downstairs: 3: Me, Dog
      Make coffee: 4: Me
      Have a breakfast: 5: Me, Dog
      Go upstairs: 3: Me, Dog
      Do work: 1: Me, Dog
    section Go home
      Go downstairs: 3: Me, Dog
      Sit down: 5: Me
饼图用于可视化带圆圈图的百分比。
:::mermaid
pie title Fishermans in countries
    "Norway" : 684
    "Sweeden" : 234
    "Switzerland" : 10
要求关系图示例
需求关系图直观显示要求及其连接。
:::mermaid
requirementDiagram
    requirement development_req {
    id: 1
    text: requirements spec.
    risk: medium
    verifymethod: test
    element test_suite {
    type: manual test
    test_suite - verifies -> development_req
若要在 Wiki 页面中嵌入来自 YouTube 和 Microsoft Streams 的视频，请使用以下语法：
::: video
> [!VIDEO https://www.youtube.com/embed/_EXAMPLE_]
iframe 对应于 YouTube 或 Microsoft Streams 视频的嵌入 iframe 块。
需要结尾“：：：”以防止页面中出现中断。
在 Wiki 中嵌入Azure Boards查询结果
若要将Azure Boards查询结果作为表嵌入 Wiki 页面中，请使用以下语法：
::: query-table <queryid>
：：： query-table 6ff7777e-8ca5-4f04-a7f6-9e63737dddf7 ：：：
还可以使用 工具栏 和 查询选择器 在 Wiki 页面中嵌入查询结果。
有关如何复制查询 URL（为查询提供 GUID）的详细信息，请参阅Email查询项或共享查询 URL。
@mention 用户和组
对于 @mention Wiki 中的用户或组，请在 Wiki 编辑器中输入“@”。 这将@mention打开自动建议，你可以从中提及用户或组通过电子邮件获得通知。
还可以从编辑工具栏中选择“@提及”。
直接在代码中编辑页面时，请使用以下模式 @<{identity-guid}>：
Wiki 网页的页面访问数
自动，你将在每个页面上看到过去 30 天的聚合页面访问计数。
使用批处理 API pagesBatch 以分页方式查看所有页面的每日访问量。 但是，它们不是按访问次数排序的。 对于超过 30 天的数据，可以使用其余 API 获取所有页面访问。 根据访问次数对这些页面进行排序，以获取前 100 个。 可以将这些访问存储在仪表板或数据库中。
页面访问定义为给定用户在 15 分钟间隔内的页面视图。
从 Wiki 页面链接到工作项
输入井号 (#) ，然后输入工作项 ID。
TFS 2018.2 及更高版本提供此功能。
Wiki 页面中的 HTML 标记支持
在 Wiki 页面中，还可以使用 HTML 标记创建丰富的内容。
可以在 HTML 中嵌套 Markdown，但必须在 HTML 元素和 markdown 之间包含一个空白行。
 [A Markdown link](https://microsoft.com) 
Azure DevOps Server 2019.1 及更高版本中支持将丰富内容粘贴为 HTML。
示例 - 嵌入视频
<video src="path of the video file" width=400 controls>
</video>
<video src="https://sec.ch9.ms/ch9/7247/7c8ddc1a-348b-4ba9-ab61-51fded6e7247/vstswiki_high.mp4" width=400 controls>
</video>
示例 - RTF 格式
<p>This text needs to <del>strikethrough</del> <ins>since it is redundant</ins>!</p>
<p><tt>This text is teletype text.</tt></p>
<font color="blue">Colored text</font>
<center>This text is center-aligned.</center>
<p>This text contains <sup>superscript</sup> text.</p>
<p>This text contains <sub>subscript</sub> text.</p>
<p>The project status is <span style="color:green;font-weight:bold">GREEN</span> even though the bug count / developer may be in <span style="color:red;font-weight:bold">red.</span> - Capability of span
<p><small>Disclaimer: Wiki also supports showing small text</small></p>
<p><big>Bigger text</big></p>
项目 wiki
Wiki 文件结构
Wiki 视图历史记录

wiki 网页的目录 (目录)

添加子页表

序列图示例

甘特图示例

流程图示例

状态图示例

用户旅程示例

要求关系图示例

在 Wiki 中嵌入Azure Boards查询结果

@mention 用户和组

Wiki 网页的页面访问数

从 Wiki 页面链接到工作项

Wiki 页面中的 HTML 标记支持