在 DocFX markdown frontmatter / YAML header 中使用标签
Using tags in DocFX markdown frontmatter / YAML header
我有一个包含多个页面的 DocFX 站点。我想通过自定义模板在每个页面的顶部包含标签,我希望作者能够在 YAML 前端添加标签,例如:
---
title: My Page Title
tags: tag1;tag2;tag3
---
然后我希望能够以某种数组的形式访问这些标签,并在生成 HTML 输出时处理它们。
我已阅读文档 here,它建议我可以在某处添加一个 schema.json
文件,这将自动检测架构中的项目。我无法解决的是如何在生成输出时访问模板中的 YAML frontmatter。
如果我需要编写自定义 .NET 插件来执行此操作,那不是问题,但我相信我应该能够以某种方式访问模板中的这些属性。
任何指导都将不胜感激!
我最终设法解决了这个问题。
在我的自定义模板中,我有一个 conceptual.html.primary.tmpl
文件,它提供了对 frontmatter 的访问:
<div id="tags">
{{#tags}}{{tags}}{{/tags}}
</div>
显然我现在需要处理标签,但我现在从我的 .md
文件中按预期生成了 HTML:
<div id="tags">
tag1;tag2;tag3
</div>
我有一个包含多个页面的 DocFX 站点。我想通过自定义模板在每个页面的顶部包含标签,我希望作者能够在 YAML 前端添加标签,例如:
---
title: My Page Title
tags: tag1;tag2;tag3
---
然后我希望能够以某种数组的形式访问这些标签,并在生成 HTML 输出时处理它们。
我已阅读文档 here,它建议我可以在某处添加一个 schema.json
文件,这将自动检测架构中的项目。我无法解决的是如何在生成输出时访问模板中的 YAML frontmatter。
如果我需要编写自定义 .NET 插件来执行此操作,那不是问题,但我相信我应该能够以某种方式访问模板中的这些属性。
任何指导都将不胜感激!
我最终设法解决了这个问题。
在我的自定义模板中,我有一个 conceptual.html.primary.tmpl
文件,它提供了对 frontmatter 的访问:
<div id="tags">
{{#tags}}{{tags}}{{/tags}}
</div>
显然我现在需要处理标签,但我现在从我的 .md
文件中按预期生成了 HTML:
<div id="tags">
tag1;tag2;tag3
</div>