如何在Github风格的Markdown中添加元数据？

Question

我想要给我的markdown文件添加元数据信息，如作者、标签等。是否可以在github风格的markdown文件中添加元数据，就像multimarkdown一样？

- Peter

---

你试过了吗？如果我没记错的话，GitHub会在文档开头将元数据简单地显示为一个表格。 - Waylan

Answer 1

在你的Markdown文档顶部使用---来像元数据一样使用yaml：

---
title: Blogging Like a Boss
author: me
---

将呈现为表格的内容：

放在文档顶部。

参考：https://github.blog/2013-09-27-viewing-yaml-metadata-in-your-documents/

- catwith

---

好的，阅读了2013年的相关文章后，我现在明白了，渲染出的“表格”是呈现元数据的预期方式。 - abernier

Answer 2

你如何向Markdown文件添加元数据将取决于该文件在Web上的呈现方式。如果你正在使用GitHub Pages将Markdown转换为HTML以用于你的网站，那么GitHub支持很可能会为你提供一些建议。

然而，如果你没有使用GitHub Pages，则需要与你正在使用的工具或渲染器讨论这个问题，以将你的Markdown转换为HTML。

例如，在我的情况下，我正在使用GitHub Pages将Markdown转换为HTML。由于我正在使用其中一个内置主题，他们要求我修改我继承的布局文件内容，以添加更多的元数据项。

- Abhey Rana

Answer 3

对于GFM，请在注释中添加元数据，如下所示：

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

这样，您的元数据就不会在浏览器或其他Markdown阅读器中呈现。此解决方案模拟了多Markdown对.yaml前置元数据的支持。

有关.md中注释的答案，请参见此答案：

Markdown中的注释

- Rowe Morehouse