文章元数据

2026-06-19

Markdown 文件顶部的 YAML 块称为 Front Matter,描述页面标题、标识、时间等元数据。everkm-publish 索引内容时读取这些字段。

最小示例

在站点根目录创建 HOME.md

---
title: 欢迎
slug: index
created_at: 2026-06-19T10:00:00+08:00
---

这是首页正文。

保存后启动 everkm-publish serve,浏览器打开 http://localhost:9081 即可看到渲染结果。

常用字段

字段必填说明
title推荐页面标题;未写 slug 时用于自动生成 slug
slug推荐URL 路径段;首页常用 index
created_at推荐创建时间,RFC3339 格式
updated_at可选更新时间,RFC3339 格式
id可选稳定唯一 ID;lint 可自动补全

旧字段 date 已废弃,请使用 created_atlint --auto-fix 可自动迁移。

时间格式

RFC3339,例如:

created_at: 2026-06-19T10:00:00+08:00
updated_at: 2026-06-19T15:30:00+08:00

slug 与 URL

  • 文件 blog/hello.mdslug: hello → 通常生成 /blog/hello-{id}.html(取决于 folders.url_id_suffix
  • 目录索引页:slug: index 或文件名 index.md
  • 根目录 HOME.md 配合 slug: index 作为站点首页

URL 规则详见 目录配置

发布前检查

everkm-publish lint ./my-site

# 自动修复:补全 id、date → created_at、部分 slug 冲突等
everkm-publish lint ./my-site --auto-fix

lint 会检查 Front Matter 完整性与 slug 唯一性,并按行号报告正文 [[...]] 内链歧义。详见 导出与发布

预览时对单个文件自动修复:

everkm-publish serve --auto-fix-on-update

正文与标题

若正文首个 h1 与 Front Matter title 文字相同,渲染时会自动隐藏该 h1,避免标题重复显示。见 毓知Markdown格式

下一步