以下是 Hugo 中 Markdown 文件开头的元数据区域(官方术语叫 Front Matter)的参数详解:
📌 结构说明
---
参数名: 值
---
本质是 YAML/TOML/JSON 格式的元数据区块,用于控制 Hugo 的渲染行为。以下对每个参数做详细解释:
一、核心元数据组
参数 | 作用说明 | 推荐值示例 |
---|---|---|
title | 文章标题,会被用作 HTML 的 <title> 标签 | "深度解析人工智能未来趋势" |
date | 文章创建时间(重要排序依据) | 2024-05-30T14:30:00+08:00 |
tags | 标签分类,支持多个标签(影响分类页面生成) | ["AI", "机器学习"] |
draft | 草稿模式开关,true 时仅在 hugo server -D 下可见 | false (发布时改为false) |
二、内容展示控制组
参数 | 功能细节 | 主题适配性 |
---|---|---|
showToc | 是否显示文章目录(需主题支持) | 大多数主题兼容 |
TocOpen | 目录初始展开状态 | 部分主题支持 |
hidemeta | 隐藏发布日期等元信息显示 | 主题相关 |
comments | 是否开启评论区(需集成 utterances 等第三方评论系统) | Disqus/Utterances 等 |
三、SEO优化组
参数 | 技术细节 |
---|---|
canonicalURL | 规范链接,用于防止重复内容SEO惩罚(当多URL指向同一内容时指定权威地址) |
description | 网页描述(重要SEO元素,建议控制在155字符内) |
disableHLJS | 禁用代码高亮(可提升页面加载速度) |
四、高级配置组
参数 | 特殊说明 |
---|---|
weight | 手动控制排序权重,值越小排序越靠前(需去掉注释 # 才能生效) |
aliases | 设置 URL 别名(示例值访问 /first 会跳转到该文章) |
cover | 头图配置: - relative: true 表示使用页面资源包(Page Bundle)中的图片 - hidden: true 仅在正文不显示头图 |
五、开发者工具组
参数 | 使用场景 |
---|---|
editPost | 添加「编辑此页」链接(需配置 Git 仓库路径): - appendFilePath: true 会自动追加文件路径 |
六、主题拓展组(不同主题功能不同)
参数 | 常见主题支持情况 |
---|---|
ShowReadingTime | 显示预计阅读时间(多数主题支持) |
ShowPostNavLinks | 显示上一篇/下一篇导航 |
UseHugoToc | 使用 Hugo 原生目录生成替代主题自带的目录系统 |
❗️ 重点注意事项
多作者声明方式:
author: "单一作者" # 或 authors: ["作者A", "作者B"] # 较新主题支持的多作者写法
时间格式规范:
- 必须使用 ISO8601 格式:
YYYY-MM-DDTHH:MM:SS±时区
- 中国时区示例:
2024-05-30T22:15:00+08:00
- 必须使用 ISO8601 格式:
关于封面图路径:
cover: image: "images/ai-cover.jpg" # 优先推荐放在 /assets/images/ 目录 # 如果使用 Page Bundle: image: "cover.jpg" relative: true
📝 新手指南
建议初始配置精简版:
---
title: "你的标题"
date: 2024-05-30T14:30:00+08:00
tags: ["标签A", "标签B"]
draft: false
showToc: true
cover:
image: "images/cover.jpg"
alt: "封面描述"
---