前置内容
前置内容(Front Matter)¶
Markdown 支持在文件顶部添加前置元数据(front-matter)。前置内容需使用 ---
(YAML 格式)或 +++
(TOML 格式)包裹。两种格式均被支持。
以下是一个 Markdown 文件前置内容的示例:
---
title: "我的第一页"
date: 2024-01-01
description: "这是我的第一页的描述。"
tags: ["介绍", "欢迎"]
---
或
+++
title = "我的第一页"
date = 2024-01-01
description = "这是我的第一页的描述。"
tags = ["介绍", "欢迎"]
+++
默认元数据字段¶
以下是 Allay 支持的默认元数据字段,均为可选:
字段 | 类型 | 说明 |
---|---|---|
head |
字符串 | 此网页的标题(不是文章标题)。 |
template |
字符串 | 指定使用的布局模板。 |
title |
字符串 | 页面标题,通常显示在页面内容的顶部。 |
date |
日期 | 页面发布日期,通常格式如 "2024-01-01"。 |
description |
字符串 | 页面描述,通常用于 SEO 和摘要。 |
tags |
列表 | 页面标签列表,用于分类和组织内容。 |
url |
字符串 | 页面自定义 URL。如果未指定,则根据文件路径生成。 |
注意:title
、description
和 tags
等字段应在你的主题模板中使用,而不是 Allay 本身。