内容字段参考
内容字段参考
本文档汇总 Vergil 所有内容类型的 frontmatter 字段,方便在写作时快速查阅。
博客文章 (blog)
文件位置:src/content/blog/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
title | string | 是 | 文章标题 |
excerpt | string | 否 | 摘要,不填则列表页不显示摘要 |
publishDate | date | 是 | 发布日期,格式 YYYY-MM-DD |
updatedDate | date | 否 | 更新日期 |
isFeatured | boolean | 否 | 是否精选,默认 false |
tags | string[] | 否 | 标签列表 |
categories | string[] | 否 | 分类路径,如 ["技术", "前端"] |
series | string | 否 | 所属专栏名称 |
draft | boolean | 否 | 草稿,默认 false |
banner | image 或 string | 否 | 封面图。推荐写 @img/...,会被优化;也支持 / 开头的 public/ 路径或外链 |
seo | object | 否 | SEO 覆盖,见下方 SEO 字段 |
fonts | object | 否 | 单篇文章字体覆盖 |
SEO 字段
YAML
seo: title: 分享标题 description: 分享描述 image: /images/share.jpg pageType: article| 字段 | 类型 | 说明 |
|---|---|---|
title | string | 分享时显示的标题,5-120 字符 |
description | string | 分享描述,15-160 字符 |
image | object | 分享图片,{ src, alt } |
pageType | string | website 或 article(默认) |
字体字段
YAML
fonts: display: 'myFont' body: 'myFont'| 字段 | 类型 | 说明 |
|---|---|---|
display | string | 标题字体 |
body | string | 正文字体 |
独立页面 (pages)
文件位置:src/content/pages/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
title | string | 是 | 页面标题 |
seo | object | 否 | SEO 覆盖 |
fonts | object | 否 | 单页字体覆盖 |
项目展示 (projects)
文件位置:src/content/projects/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
title | string | 是 | 项目名称 |
description | string | 否 | 项目描述 |
publishDate | date | 是 | 发布日期 |
isFeatured | boolean | 否 | 是否精选,默认 false |
seo | object | 否 | SEO 覆盖 |
fonts | object | 否 | 字体覆盖 |
相册 (albums)
文件位置:src/content/albums/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
title | string | 是 | 相册标题 |
description | string | 否 | 相册描述 |
date | date | 是 | 创建日期 |
cover | image | 否 | 封面图 |
images | array | 否 | 照片列表 |
tags | string[] | 否 | 标签 |
theme | string | 否 | 主题:golden 或 seasons,默认 golden |
layout | string | 否 | 布局:grid、masonry、timeline、carousel,默认 grid |
photoFit | string | 否 | 图片填充:cover、contain、auto,默认 cover |
background | string | 否 | 自定义背景 |
accent | string | 否 | 自定义强调色 |
seasonFilter | boolean | 否 | 是否显示季节筛选,默认 false |
seasonDefault | string | 否 | 默认季节:spring、summer、autumn、winter |
fonts | object | 否 | 字体覆盖 |
照片字段
每张照片支持:
| 字段 | 类型 | 说明 |
|---|---|---|
src | image | 照片文件(必填) |
alt | string | 替代文字 |
caption | string | 说明文字 |
season | string | 季节:spring、summer、autumn、winter |
featured | boolean | 是否精选 |
exif | object | EXIF 数据 |
EXIF 字段
| 字段 | 类型 | 说明 |
|---|---|---|
camera | string | 相机型号 |
lens | string | 镜头 |
focal | string | 焦距 |
aperture | string | 光圈 |
shutter | string | 快门速度 |
iso | string | ISO |
datetime | string | 拍摄时间 |
知识库文档 (docs)
文件位置:src/content/docs/**/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
title | string | 是 | 文档标题 |
subtitle | string | 否 | 副标题 |
description | string | 否 | 描述 |
icon | string | 否 | 文档图标 |
order | number | 否 | 排序序号,默认 99 |
dirs | array | 否 | 目录结构配置 |
excerpt | string | 否 | 摘要 |
autoRender | boolean | 否 | 是否自动渲染子目录,默认 true |
draft | boolean | 否 | 草稿,默认 false |
homepage | string | 否 | 首页跳转路径 |
tags | string[] | 否 | 标签 |
cover | image | 否 | 封面图 |
banner | image 或 string | 否 | 横幅图,写法同博客的 banner |
splash | object | 否 | 开屏页配置 |
Splash 字段
| 字段 | 类型 | 说明 |
|---|---|---|
enabled | boolean | 是否启用开屏页 |
backgroundImage | string | 背景图 URL |
overlay | string | 遮罩颜色 |
textShadow | boolean | 文字阴影 |
buttonText | string | 按钮文字 |
fallbackBg | string | 备用背景 |
gradientColor | string | 渐变颜色 |
gradientHeight | string | 渐变高度 |
backdropBlur | string | 毛玻璃模糊 |
glass | object | 按钮的玻璃效果:nav 可选 solid、frosted、liquid,tint 是底色浓度。只写想改的项,其余沿用站点开屏页配置 |
简历 (resume)
文件位置:src/content/resume/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
title | string | 是 | 简历标题 |
name | string | 是 | 姓名 |
avatar | string | 否 | 头像路径 |
contact | object | 否 | 联系方式 |
Contact 字段
| 字段 | 类型 | 说明 |
|---|---|---|
email | string | 邮箱 |
phone | string | 电话 |
location | string | 所在地 |
website | string | 个人网站 |
想法 (thoughts)
文件位置:src/content/thoughts/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
date | date | 是 | 日期 |
tags | string[] | 否 | 标签 |
专栏 (series)
文件位置:src/content/series/*.md
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
name | string | 是 | 专栏名称 |
description | string | 否 | 专栏描述 |
cover | image 或 string | 否 | 专栏封面,显示在专栏列表里。推荐写 @img/series/<专栏名>/cover.svg |
icon | string | 否 | 图标 |
dir | string | 否 | 专栏文章所在的一级目录,相对于 src/content/blog/。填了之后该目录下的文章自动归属本专栏,目录名不进 URL |
字段速查
常用字段汇总
| 字段 | blog | pages | projects | albums | docs | resume | thoughts | series |
|---|---|---|---|---|---|---|---|---|
title | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ||
name | ✓ | ✓ | ||||||
description | ✓ | ✓ | ✓ | ✓ | ✓ | |||
publishDate | ✓ | ✓ | ||||||
date | ✓ | ✓ | ||||||
updatedDate | ✓ | |||||||
tags | ✓ | ✓ | ✓ | ✓ | ||||
categories | ✓ | |||||||
series | ✓ | |||||||
draft | ✓ | ✓ | ||||||
seo | ✓ | ✓ | ✓ | |||||
fonts | ✓ | ✓ | ✓ | ✓ | ||||
banner | ✓ | ✓ | ||||||
cover | ✓ | ✓ | ✓ | |||||
isFeatured | ✓ | ✓ |