浏览文档

配置结构

2023年2月17日 1 分钟阅读 配置 文档
本页内容

本文将尽量简单地介绍 Hugo 的配置结构，以便你能更好地理解文档中的配置，即使你刚刚接触 Hugo。

配置格式

虽然 Hugo 支持 TOML、YAML 和 JSON，不过笔者建议使用 TOML 或 YAML，因为 JSON 并不支持注释。

配置名称

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

HB 要求 Hugo 0.110.0 以上版本，文档中的配置均以 hugo.* 命名。

单配置文件

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

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

配置目录

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

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

如上所示，站点们定义了四种环境：

环境描述
_default默认配置，会被合并到最终的配置中去。
development开发环境，hugo server 默认环境。
staging自定义环境，可以通过 -e staging 加载。
production生产环境，hugo 默认环境。

通常我们需要在本地预览其他环境，如生产环境，只需要通过 hugo server -e production -b http://localhost:1313 -p 1313。

配置文件描述
hugo.*Hugo 配置文件
params.*参数配置
menus.*菜单配置
languages.*语言配置

Hugo 支持对某一特定语言进行配置，如上所展示的 menus.en.toml、menus.zh-hans.toml、params.en.toml 和 params.zh-hans.toml。