Skip to content

Markdown 中的 Frontmatter

Frontmatter 是 Markdown 文件頂部的一個特殊部分,用於存儲文檔的元數據。它通常使用 YAML 格式,被三個破折號(---)包圍。

什麼是 Frontmatter?

Frontmatter 允許你在 Markdown 文檔中嵌入結構化的元數據,這些數據可以被靜態網站生成器、內容管理系統和其他工具使用。

基本語法

markdown
---
title: 我的文檔標題
author: 張三
date: 2024-01-15
---

# 我的文檔標題

這裡是文檔的正文內容...

支持的格式

雖然 YAML 是最常見的,但有些系統也支持其他格式:

YAML(推薦)

markdown
---
title: 我的文章
tags: [markdown, tutorial]
---

JSON

markdown
---
{
  "title": "我的文章",
  "tags": ["markdown", "tutorial"]
}
---

TOML

markdown
+++
title = "我的文章"
tags = ["markdown", "tutorial"]
+++

常用字段

標題和描述

yaml
---
title: Markdown 完全指南
description: 學習 Markdown 語法和最佳實踐的綜合指南
keywords: markdown, 教程, 指南, 語法
---

結論

Frontmatter 是管理 Markdown 文檔元數據的強大工具。正確使用它可以讓你的內容更加結構化、易於管理,並且與各種工具和平臺無縫整合。

其他資源

由 Markdownlang.com 整理創建