如何在 Github-Flavoured-Markdown 中添加元數據？

Question

我想將元數據信息添加到我的 markdown 文件中，例如作者、標簽、...。 是否可以將元數據添加到 github-flavoured-markdown 文件中，就像您可以使用multimarkdown一樣？

Answer 1

如何將元數據添加到 Markdown 文件將取決於該文件在 Web 上的呈現方式。 如果您使用 GitHub 頁面將 Markdown 轉換為您網站的 HTML，那么 GitHub 支持可能會為您提供一些建議。

但是，如果您不使用 GitHub Pages，則需要與用於將 Markdown 轉換為 HTML 的任何工具或渲染器進行討論。

例如，在我的情況下，我使用 GitHub 頁面將 Markdown 轉換為 HTML。 當我使用他們的內置主題之一時，他們要求我修改我繼承的布局文件的內容，以便向其中添加更多元數據項。

Answer 2

在 markdown 的頂部使用 yaml 之類的元數據--- ：

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

它將像表格一樣呈現：

在文檔的頂部。

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

Answer 3

對於GFM ，在注釋中添加您的元數據，如下所示：

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

...因此您的元數據不會在瀏覽器或其他降價閱讀器中呈現。 此解決方案模擬.yaml對.yaml前端元數據的支持。

請參閱有關.md注釋的答案：

Markdown 中的評論