Azure DevOps Wiki：页面顶部的YAML对于Markdown有什么价值？

Question

添加YAML到Azure DevOps Wiki页面的Markdown上有何价值，如其Markdown语法所支持的：Wiki中Markdown用法的语法指南，包括YAML标签？

看起来它提供的只是一种替代语法来指定表格。也许更复杂一些的表格，但它们只会呈现在页面顶部。我错过了什么吗？

- ScottWelker

---

“Markdown使用指南，YAML标签”（https://learn.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#yaml-tags）不再提及Azure DevOps Wiki的YAML功能。可能已被删除。 - ScottWelker

Answer 1

作为文档中的介绍，

任何包含Wiki中YAML块的文件都将被处理成具有一个标题和一行的表格。

因此，我认为Wiki markdown中YAML标签的价值在于将抽象的YAML语句转换为可视化的表格，以增加可读性和快速理解能力。

特别是对于可能包含多个项目或多个子项目的复杂YAML块，YAML标签应该非常有帮助。

[更新]

我发现了一个问题票(MicrosoftDocs/azure-devops-docs#9976)，由GitHub存储库"MicrosoftDocs/azure-devops-docs"上的另一个用户报告了类似的问题。

在这个问题票中，你也可以看到@amitkumariiit给出了一个解释：

Yaml标签用于一般搜索引擎优化。我们的计划是首先添加基本支持，然后将其摄入Azure DevOps Wiki搜索以优化搜索。但是，我们无法优先考虑搜索工作方面。

如果您需要更详细的解释，可以关注此问题票并添加您的评论。

- Bright Ran-MSFT

---

感谢@Bright Ran-MSFT。然而，所引用的“value”似乎是对其功能的重申。我理解它的功能，但我不明白这如何增加价值？如果我想要将YAML显示为表格，为什么我只想在页面顶部看到它？真实世界中的用例是什么？我真的看不出这如何产生任何积极的效果。 - ScottWelker

我接受你的 [更新] 作为答案。谢谢。 - ScottWelker

@Bright-Ran-MSFT 我尝试插入我的YAML文件内容（Kubernetes清单或Spring配置），渲染后并没有使其更易读。当前实现不支持深层嵌套元素。任何深度超过3级的元素都会被包装到表格单元格中。你可以自己试一下。 - vbg

Answer 2

我打算提出自己的答案。我突然想到，这很可能是用来替换Markdown而不是与Markdown一起使用的。也就是说，支持纯YAML编写的文档。这可能有些道理，对某些人有价值，并解释了为什么它仅在页面顶部受支持。你可以使用它来代替Markdown，而不是与Markdown一起使用。

文档并没有清楚地说明您可能希望如何使用此功能。

- ScottWelker

---

这个问题困扰了我很长时间。我的答案对我来说是有意义的。我们会看到是否还有其他评论。我可能会接受我的答案。 - ScottWelker

嗨，@ScottWelker，请继续。 - Bright Ran-MSFT

嗨@ScottWelker，我已经更新了我的答案并添加了更多信息。这可能对你有所帮助，请查看一下。 - Bright Ran-MSFT

@Bright Ran-MSFT：感谢您的"侦探工作"。我已经接受了您的答案，因为它证明了我的猜测是错误的。 YAML支持显然只是另一个功能（搜索）的不完全部分。 - ScottWelker