通过

将 Markdown 添加到仪表板

  • 项目

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

通过添加如下信息，使用 Markdown 小组件来支持团队和利益干系人：

  • 团队目标。
  • 指向：
    • 团队积压工作或板。
    • 指标
    • 位于网络共享中的其他项目，例如 OneNote、SharePoint 网站或 Wiki 网页。
  • 重要日期或目标截止时间。

下面是一个示例：
示例 Markdown 小组件的屏幕截图。

先决条件

  • 访问：
  • 权限：
    • 团队仪表板：若要添加、编辑或管理团队仪表板，请满足以下要求：
      • 成为团队成员。
      • 是项目管理员组的成员。

注意

图表或小组件中显示的数据受已登录用户授予的权限的约束。 例如，如果用户无权查看特定区域路径下的工作项，则这些项不会显示在仪表板上的查询结果小组件中。 有关详细信息，请参阅 有关使用仪表板的常见问题解答。

支持的 Markdown 语法

Markdown 小组件支持 CommonMark 标准功能，例如：

  • 标题
  • 段落和换行符
  • 块引用
  • 水平标尺
  • 强调（粗体、斜体、删除线）
  • 表
  • 列表（已排序和无序）
  • 链接
  • 映像
  • 转义字符

有关用法的详细信息，请参阅 基本 Markdown 用法的语法指南。

出于性能原因，Markdown 小组件不会添加对许多扩展功能的支持，其中许多功能在 Wiki 中受支持。 扩展功能将阻碍小组件加载时间。 例如，Markdown 小组件不支持以下扩展的 Markdown 功能：

  • 嵌入式 HTML 语法
  • 代码突出显示（wiki/其他人支持语言语法感知颜色编码，CommonMark 仅将代码呈现为纯预格式化文本）
  • 清单
  • 表情符号字符
  • 附件
  • 数学公式

连接到项目

若要将 Markdown 小组件添加到仪表板，请使用受支持的 Web 浏览器连接到项目。

打开 Web 浏览器，连接到项目，然后选择“ 概述>仪表板”。

Web 门户的屏幕截图，打开仪表板。

如果需要切换到其他项目，请选择 Azure DevOps 徽标以 浏览所有项目。

添加 Markdown 小组件

如果需要添加仪表板，请参阅 “添加”、“重命名”和“删除仪表板”。

若要将 Markdown 小组件添加到仪表板，请选择“ 编辑”。 小组件目录将自动打开。

  1. 将 Markdown 小组件添加或拖动到所需位置的仪表板上。

    Markdown 小组件的屏幕截图。

  2. 选择“完成编辑”退出仪表板编辑。 这将消除小组件目录。 然后，可以根据需要配置 Markdown 小组件。

  3. 选择 齿轮图标 齿轮图标以打开小组件的配置对话框。

    若要编辑 Markdown 小组件，可能需要是团队管理员、项目管理员组的成员或被授予权限。 有关详细信息，请参阅 “设置仪表板权限”。

  4. 根据需要调整小组件大小，以适应要输入的 Markdown 的内容。 最大大小为 10 个磁贴，宽为 10 个磁贴。 以后始终可以对此进行调整。

    Markdown 小组件配置对话框的屏幕截图，更改大小。

  5. 在配置对话框中输入文本和 Markdown 语法。 有关支持的语法，请参阅 Markdown 文件的语法指南、小组件、wiki 和拉取请求注释。

    下面显示了一些带有项目符号列表的简单文本，其中包含四个链接

    配置 markdown、文本条目的屏幕截图。

    提示

    若要链接到 Wiki 页面，请使用以下语法：
    /ProjectName/_wiki/wikis/WikiRepositoryName?pagePath=/FileName

    若要链接到项目中的存储库文件、页面或图像，请丰富单击该文件并使用完整的 URL。

    这会呈现以下小组件：

    Web 门户的示例 Markdown 小组件的屏幕截图。

    注意

    不支持指向使用 file:// 文件共享的文档的链接。 出于安全目的，已实施此限制。

  6. （可选）可以选择指向存储库中的文件。

    使用存储库文件配置 Markdown 小组件的屏幕截图。