Markdown MetaData 元数据总结

Markdown 是一种轻量级的标记语言，非常适合编写文档和博客。为了更好地组织和管理这些文档，通常会在 Markdown 文件的顶部添加元数据（Front Matter）。本文将总结 Markdown 元数据的常见用法和示例，包括如何设置特性图片。

什么是元数据？

元数据是附加在文档顶部的结构化信息，用于描述文档的属性，如标题、作者、日期和标签等。这些信息对内容管理系统（如 Jekyll、Hugo）或静态站点生成器非常有用，帮助它们正确地处理和展示文档内容。

元数据格式

元数据通常放在文档的开头部分，用三条短横线（---）包围。例如：


---

title: "Markdown 元数据总结"
date: 2024-06-25
author: "Your Name"
tags: ["Markdown", "元数据", "博客写作", "指南"]
featured_image: "https://example.com/path/to/your/image.jpg"

---

通用的元数据键值

以下是一些常见的元数据键值对：

1. title

描述: 文档标题
类型: 字符串
示例:
```
title: "Markdown 元数据总结"
```

2. date

描述: 创建或发布日期
类型: 日期
格式: YYYY-MM-DD
示例:
```
date: 2024-06-25
```

3. author

描述: 作者姓名
类型: 字符串
示例:
```
author: "Your Name"
```

4. tags

描述: 文档的标签或关键词
类型: 列表

示例:

tags: ["Markdown", "元数据", "博客写作", "指南"]

5. featured_image

描述: 特性图片的 URL
类型: 字符串

示例:

featured_image: "https://example.com/path/to/your/image.jpg"

6. Category

描述: 设置分类
类型: 字符串
示例:
```
categories:
- 教程
- 技术/前端
```

WordPress 特殊元数据

WordPress 默认不支持Markdown，也不支持Markdown元数据的标记，不过我们可以通过Git It Write插件实现在github写代码，然后自动更新到Wordpress，并且支持通过特定的MetaData来指定Tag、Category等，以及一些Wordpress特有的MetaData。

Git It Write MetaData语法

Git it Write的语法和通用语法不太相同，参考官方说明，重点部分摘录如下：

参数	描述	示例
`title`	文章标题	–
`menu_order`	菜单顺序	–
`post_status`	文章状态	publish, draft, pending, future
`post_excerpt`	文章摘要	–
`post_date`	要设置的文章日期	`2022-09-01 20:14:59`
`comment_status`	文章评论状态	open, closed
`page_template`	页面模板	–
`stick_post`	置顶文章	yes, no
`taxonomy`	文章分类法	标签、分类等
`custom_fields`	自定义字段	–
`skip_file`	跳过发布文件	yes
`featured_image`	特色图片路径	`_images/post-image-1.png`

例如下面的范例：

title: Title of the post
menu_order: 1
post_status: publish
post_excerpt: This is a post excerpt
featured_image: _images/post-image.jpg
taxonomy:
    category:
        - category-slug-1
        - category-slug-2
    post_tag:
        - tag-1
        - tag-2
custom_fields:
    field1: value 1
    field2: value 2

使用的时候需要注意以下几点：

featured_image不支持Url，只支持本地图片
本地图片只能位于git仓的_image下面
category和post_tag都在taxonomy中实现

静态站点生成器MetaData参考连接

Jekyll
- Jekyll Front Matter
Hugo
- Hugo Front Matter
Hexo
- Hexo Front Matter
Gatsby
- Gatsby Front Matter
Pelican
- Pelican Metadata

如何设置特性图片

WordPress设置

featured_image: _images/post-image.jpg

featured_image不支持Url，只支持本地图片

其他通用设置

特性图片（Featured Image）是博客文章中一张突出的图片，通常用于代表文章内容，在文章列表或社交媒体分享时显示。通过在元数据中添加 featured_image 键，可以设置特性图片。例如：


---

title: "Markdown 元数据总结"
date: 2024-06-25
author: "Your Name"
tags: ["Markdown", "元数据", "博客写作", "指南"]
featured_image: "https://example.com/path/to/your/image.jpg"

---

设置特性图片的步骤

准备图片：选择并准备一张合适的图片，并将其上传到你的图片托管服务（如 Imgur、AWS S3 或你的网站）。
获取图片 URL：复制图片的 URL 地址。
添加元数据：在 Markdown 文件的元数据部分添加 featured_image 键，并设置其值为图片的 URL。

通过以上步骤，你可以轻松地为每篇文章设置特性图片，使其在展示时更加醒目。

元数据的作用

组织文档: 元数据帮助对文档进行分类和组织，例如按标签或日期排序。
SEO 优化: 提供更详细的信息，有助于搜索引擎优化（SEO）。
自动化处理: 静态站点生成器可以利用元数据自动生成目录、索引和归档页面。
视觉吸引力: 通过设置特性图片，提升文章的视觉吸引力和点击率。