命令

hugo convert toYAML

把内容目录中的前置元数据统一改写为 YAML 格式。

hugo convert toYAML 是 hugo convert 的子命令,用于把内容目录中所有文件的前置元数据都改为 YAML 格式。YAML 前置元数据以三个连字符组成的分隔行包裹,可读性好、嵌套结构表达自然,是许多站点与主题文档默认采用的写法;从其他静态站点生成器迁移过来时,这个子命令最常被用到。

用法

hugo convert toYAML [flags] [args]

命令遍历内容目录中的每个内容文件,就地改写其前置元数据,正文保持不变。转换完成后建议先构建一次或本地预览确认页面数据仍然正常。

选项

选项 说明
-h, --help 显示 toYAML 子命令的帮助信息

继承自父命令的选项

选项 说明
--clock string 设定 Hugo 使用的时钟,例如 --clock 2021-11-06T22:30:00.00+09:00
--config string 指定配置文件,默认为 hugo.yaml、hugo.json 或 hugo.toml
--configDir string 配置目录,默认为 config
-d, --destination string 写入文件的文件系统路径
-e, --environment string 构建环境
--ignoreVendorPaths string 对匹配给定 Glob 模式的模块路径忽略其中的 _vendor
--logLevel string 日志级别:debug、info、warn 或 error
--noBuildLock 不创建 .hugo_build.lock 文件
-o, --output string 写入文件的文件系统路径
--quiet 以静默模式构建
-M, --renderToMemory 渲染到内存,主要用于运行服务器时
-s, --source string 读取文件时相对的起始文件系统路径
--themesDir string 主题目录的文件系统路径
--unsafe 启用安全性较低的操作,请先备份

示例

把项目内容的前置元数据统一转换为 YAML:

hugo convert toYAML

转换会原地改写源文件,确认已有备份或已纳入版本控制后,可按需加上 --unsafe:

hugo convert toYAML --unsafe

先把结果输出到另一个目录,确认无误后再替换原文件:

hugo convert toYAML --output converted

说明

  • -o、--output 与 --unsafe 继承自父命令 hugo convert,其余继承选项来自顶层 hugo 命令。
  • YAML 用缩进表达层级,改写嵌套字段(例如分类法列表或多值字段)时最直观;代价是缩进必须严格一致。
  • 只有前置元数据会被改写,Markdown 正文与页面资源不受影响。
  • 前置元数据里可用字段的含义见前置元数据;其他目标格式的写法见 hugo convert toJSON 与 hugo convert toTOML。