【问题标题】:How to add metadata in Github-Flavoured-Markdown?如何在 Github-Flavored-Markdown 中添加元数据?
【发布时间】:2017-03-22 12:50:35
【问题描述】:

我想将元数据信息添加到我的 Markdown 文件中,例如作者、标签等。是否可以像 multimarkdown 那样将元数据添加到 github-flavored-markdown 文件中?

【问题讨论】:

  • 你试过了吗? IIRC,GitHub 将简单地将元数据显示为文档开头的表格。

标签: markdown github-flavored-markdown multimarkdown


【解决方案1】:

如何将元数据添加到 Markdown 文件将取决于该文件在 Web 上的呈现方式。如果您使用 GitHub 页面将标记转换为您网站的 HTML,那么 GitHub 支持可能会为您提供一些建议。

但是,如果您不使用 GitHub Pages,则需要与您用于将 Markdown 转换为 HTML 的任何工具或渲染器进行讨论。

例如,在我的例子中,我使用 GitHub 页面将该降价转换为 HTML。当我使用他们的一个内置主题时,他们要求我修改我继承的布局文件的内容,以便向其中添加更多元数据项。

【讨论】:

    【解决方案2】:

    对于GFM,在 cmets 中添加您的元数据,如下所示:

    [//]: # (Title: Marketing Meeting Notes)
    [//]: # (Author: Alan Smithee)
    [//]: # (Attendees: Larry, Curly, Moe)
    [//]: # (Tags: #training #onboarding)
    [//]: # (Date: June 18, 2015)

    ...所以您的元数据不会在浏览器或其他 Markdown 阅读器中呈现。该解决方案模拟了 multimarkdown 对 .yaml 前端元数据的支持。

    请参阅.md 中有关 cmets 的答案:

    Comments in Markdown

    【讨论】:

      猜你喜欢
      • 2016-09-18
      • 2012-08-10
      • 1970-01-01
      • 1970-01-01
      • 2013-08-03
      • 1970-01-01
      • 2021-05-16
      • 1970-01-01
      • 2013-03-19
      相关资源
      最近更新 更多