配置结构

赞助

成为我们的资助者或赞助商,以支持我们的工作。

赞助商

本文将尽量简单地介绍 Hugo 的配置结构。

配置格式

虽然 Hugo 支持 TOMLYAMLJSON,不过笔者建议使用 TOMLYAML,因为 JSON 并不支持注释。

配置名称

自 Hugo 0.110.0 版本后,Hugo 将优先使用 hugo.* 配置文件,尽管 config.* 仍起作用,不过笔者建议使用 hugo.* 作为配置名称,以与其他项目的配置区分开来。

单配置文件

单配置文件是指在项目根目录下的 hugo.*

Hugo 也可以通过 --config 参数指定多个配置文件:hugo --config a.toml,b.toml,c.toml

配置目录

虽然单配置文件简单便捷,但缺点也很明显,一旦配置过多,就难以阅读,在多环境、多语言的情况下更为糟糕,而配置目录可以更好地应对这种情况。

 1tree config
 2config
 3├── _default
 4│   ├── hugo.toml
 5│   ├── languages.toml
 6│   ├── menus.en.toml
 7│   ├── menus.zh-hans.toml
 8│   └── params.toml
 9│   └── params.en.toml
10│   └── params.zh-hans.toml
11├── development
12│   ├── hugo.toml
13│   └── params.toml
14├── production
15│   ├── hugo.toml
16│   └── params.toml
17└── staging
18    ├── hugo.toml
19    └── params.toml

如上所示,站点们定义了四种环境:

环境描述
_default默认配置,会被合并到最终的配置中去。
development开发环境,hugo server 默认环境。
staging自定义环境,可以通过 -e staging 加载。
production生产环境,hugo 默认环境。
配置文件描述
hugo.*Hugo 配置文件
params.*参数配置
menus.*菜单配置
languages.*语言配置

Hugo 支持对某一特定语言进行配置,如上所展示的 menus.en.tomlmenus.zh-hans.tomlparams.en.tomlparams.zh-hans.toml

了解更多

razonyang
2024年11月21日星期四 2023年2月17日星期五