Front Matter 是 Markdown 文件开头的元数据区域,用于配置文章的各种属性。极简主题支持丰富的 Front Matter 配置项。
基本结构
Front Matter 使用 YAML 格式,位于文章开头,以 --- 分隔:
1
2
3
4
5
6
7
8
|
---
title: "文章标题"
date: 2025-03-13T10:00:00+08:00
tags: ["标签1", "标签2"]
categories: ["分类"]
---
文章正文内容...
|
必需配置项
title
文章标题,必填项。
date
发布时间,推荐使用 ISO 8601 格式:
1
|
date: 2025-03-13T10:00:00+08:00
|
也支持简单格式:
基础配置项
draft
标记文章为草稿状态,Hugo 默认不会渲染草稿文章:
1
2
|
draft: true # 草稿
draft: false # 正式发布(默认值)
|
预览草稿:hugo server -D
description
文章描述,用于 SEO 和社交媒体分享:
1
|
description: "这是一篇关于 Hugo 主题配置的文章"
|
summary
自定义文章摘要,显示在文章列表中:
1
|
summary: "这是自定义的摘要内容,将显示在首页列表中"
|
也可以使用 `
` 标签在正文中截断:
1
2
3
4
5
|
这是文章开头的导语,会显示在列表中。
<!--more-->
从这里开始的内容只在详情页显示。
|
文章标签,数组格式:
1
|
tags: ["Hugo", "主题", "教程"]
|
categories
文章分类,数组格式:
1
|
categories: ["技术", "前端"]
|
author
文章作者:
封面图片配置
cover
设置文章封面图片,支持多个属性:
1
2
3
4
5
6
|
cover:
image: "/images/cover.jpg" # 图片路径
alt: "封面图片描述" # 替代文本(无障碍访问)
caption: "图片来源:网络" # 图片说明
relative: false # 是否相对于文章目录
hidden: true # 是否在文章内隐藏封面图
|
封面图片推荐规格
- 推荐比例:16:9 或 1.44:1 (13:9)
- 推荐宽度:1500px 以上
- 推荐格式:WebP(体积更小,加载更快)
示例:
1
2
3
|
cover:
image: "/images/posts/welcome.webp"
alt: "欢迎页面封面"
|
images
社交媒体分享时显示的预览图,数组格式:
1
|
images: ["/images/og-cover.jpg"]
|
优先级:文章 images > 文章 cover.image > 全局 images
排序与权重
weight
文章排序权重,数字越小越靠前:
1
2
|
weight: 1 # 排在前面
weight: 10 # 排在后面
|
同权重时按日期倒序排列(最新在前)。
目录与导航
ShowToc
是否显示文章目录(覆盖全局设置):
1
2
|
ShowToc: true # 显示目录
ShowToc: false # 隐藏目录
|
tocopen
默认展开目录:
enableAnchoredHeadings
是否启用标题锚点链接(标题旁显示 # 符号):
1
|
enableAnchoredHeadings: true
|
功能开关
开启或关闭文章评论:
隐藏文章元数据(日期、阅读时长等):
hideSummary
在文章详情页隐藏摘要:
显示分享按钮(覆盖全局设置):
showPostNavLinks
显示上一篇/下一篇导航:
showBreadCrumbs
显示面包屑导航:
showEdit
显示编辑文章链接:
1
2
3
4
5
|
showEdit: true
editPost:
URL: "https://github.com/user/repo/edit/main/content"
Text: "编辑此页"
appendFilePath: true
|
完整示例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
|
---
title: "Hugo 极简主题使用指南"
date: 2025-03-13T10:00:00+08:00
draft: false
description: "详细介绍 Hugo 极简主题的各种功能和配置方法"
summary: "本文将介绍如何安装、配置和使用极简主题的所有功能"
author: "莫莫先生"
tags: ["Hugo", "主题", "教程", "Markdown"]
categories: ["技术文档"]
cover:
image: "/images/covers/hugo-jijian.webp"
alt: "Hugo 极简主题封面"
caption: "极简主题演示"
images: ["/images/covers/hugo-jijian-og.webp"]
weight: 1
ShowToc: true
tocopen: true
enableAnchoredHeadings: false
comments: true
showShareButtons: true
showPostNavLinks: true
showBreadCrumbs: true
---
文章正文开始...
|
日期格式参考
支持多种日期格式:
1
2
3
|
date: 2025-03-13T10:00:00+08:00 # ISO 8601(推荐)
date: 2025-03-13 # 简单日期
date: 2025-03-13 10:00:00 # 带时分秒
|
配置优先级
文章级配置 > 站点级配置 > 默认值
例如:
- 文章设置
ShowToc: false,即使全局配置为 true,该文章也不显示目录
- 文章未设置
ShowToc,则使用全局配置
相关配置
通过合理配置 Front Matter,可以充分利用主题的各种功能,打造专业美观的文章页面。