在Azure DevOps中使用Markdown图表

55次阅读
没有评论

问题描述

想要在项目的源代码中包含Markdown图表,并且在查看源代码/拉取请求时,希望在Azure DevOps中的预览选项卡中看到渲染后的图表。虽然支持md文件,但似乎不支持mermaid图表。用户想知道是否有办法启用mermaid图表,或者是否有其他支持的替代方案?
请注意:不是在Wiki中,而是在源代码存储库中的文件。

解决方案

在继续之前,请确保你了解所有操作的影响,建议在进行任何更改前备份相关数据。

使用Mermaid INK嵌入图表

在源代码存储库中,Azure DevOps并不直接支持在Markdown文件中渲染mermaid图表。然而,有一个名为Mermaid INK的解决方案,可以帮助你在Markdown文件中嵌入图表并进行渲染。以下是操作步骤:

  1. 打开 Mermaid INK 编辑器。
  2. 在编辑器中编写你的mermaid图表代码。
  3. 在编辑器底部找到Markdown链接,将该链接嵌入到你的Markdown文件中。

这种方法的一个缺点是,你失去了纯文本图表代码的版本控制。但是,图像的链接将带你回到编辑器,其中包含生成图像所使用的准确代码副本。

使用支持的图表类型

如果你想要在源代码存储库中使用内置的Markdown图表,可以考虑使用Azure DevOps支持的其他图表类型。在Markdown文件中,支持一些图表,但mermaid图表并不被支持。你可以查阅Azure DevOps文档以获取支持的图表类型列表。

使用VS Code的Mermaid扩展

如果你更喜欢在VS Code中编写和渲染mermaid图表,可以考虑使用以下两个VS Code扩展:

  • bierner.markdown-mermaid: 这个扩展可以渲染mermaid图表。
  • bpruitt-goddard.mermaid-markdown-syntax-highlighting: 这个扩展可以为mermaid代码块提供语法高亮。

这些扩展可以在VS Code中帮助你更方便地编写和预览mermaid图表。

无论你选择哪种方法,都可以在Azure DevOps的Markdown文件中呈现图表,以提供更清晰的文档和可视化效果。

注意:以上操作可能涉及到一些版本差异或者环境配置,请确保在进行任何更改之前查阅相关文档和文档更新。

正文完