ESC博客YAML文件

YAML（YAML Ain't Markup Language）是一种类似于JSON的轻量级数据格式，被广泛用于配置文件、数据序列化等场景。

在ESC博客中，我们采用了YAML文件作为博客文章的元数据存储格式，以方便管理和展示。本文将介绍ESC博客中的YAML文件格式及其相关细节。

基本格式

每篇博客文章都应该有一个对应的YAML文件，以博客文章的文件名（不包含扩展名）作为YAML文件的名称，并放置于文章所在的目录下。

例如，一篇博客文章文件名为hello-world.md，则对应的YAML文件名应为hello-world.yaml，并放置于hello-world.md同级目录下。

文章的YAML文件的基本格式如下：

---
title: Hello World
date: 2021-01-01
categories:
  - 技术
  - 编程
tags:
  - Java
  - Spring
author: John Doe
---

其中，---用于表示YAML文件的开始和结束处。文件内的内容使用YAML语法进行标记。

具体字段的含义如下：

• title：文章的标题，必填项。
• date：文章的发布日期，必填项。格式为YYYY-MM-DD。
• categories：文章所属类别，可选项。可以有多个类别。
• tags：文章的标签，可选项。可以有多个标签。
• author：文章的作者，可选项。如果没有指定作者，默认为站点作者。

高级选项

除了基本字段外，YAML文件还可以支持一些高级选项，用于进一步控制文章的展示和行为。

代码高亮

如果文章中包含代码，可以通过YAML文件指定代码的语言，以便系统采用合适的代码高亮方案。

---
title: Hello World
date: 2021-01-01
categories:
  - 技术
  - 编程
tags:
  - Java
  - Spring
author: John Doe
highlight: java
---

其中的highlight字段可以设置为任意支持的代码语言，例如java、python等。

封面图片

如果文章需要使用封面图片，可以在YAML文件中指定图片链接。

---
title: Hello World
date: 2021-01-01
categories:
  - 技术
  - 编程
tags:
  - Java
  - Spring
author: John Doe
cover: https://example.com/path/to/cover.png
---

其中的cover字段应该指定为图片的链接地址。系统会在文章页面上展示该图片作为封面。

文章摘要

如果文章需要在文章列表页上展示摘要信息，可以在YAML文件中指定文章的摘要。

---
title: Hello World
date: 2021-01-01
categories:
  - 技术
  - 编程
tags:
  - Java
  - Spring
author: John Doe
excerpt: 这里是文章的摘要信息，可以包含一些简短的介绍。
---

其中的excerpt字段应该指定为摘要信息文本。系统会在文章列表页上展示该摘要信息。

参考链接

• YAML - YAML官方网站，包含了YAML的语法规范和实现列表。
• Jekyll Front Matter - Jekyll中的Front Matter规范，与本文中的YAML格式类似，可作为参考。