构建选项
构建选项存储在一个名为 build 的保留前置 matter 对象中，其默认值如下：
content/example/index.md
---
build:
list: always
publishResources: true
render: always
---+++
[build]
list = 'always'
publishResources = true
render = 'always'
+++{
"build": {
"list": "always",
"publishResources": true,
"render": "always"
}
}
- list
- 何时将页面包含在页面集合中。指定以下其中一个：
-
always- 将页面包含在 所有 页面集合中。例如，
site.RegularPages、.Pages等。这是默认值。
-
local- 将页面包含在 局部 页面集合中。例如，
.RegularPages、.Pages等。使用此选项可以创建完全可导航但无头的内容部分。
-
never- 不要将页面包含在 任何 页面集合中。
-
- publishResources
- 适用于 页面包 ，确定是否发布关联的 页面资源 。指定以下其中一个：
-
true- 始终发布资源。这是默认值。
-
false- 仅在模板中调用其
Permalink、RelPermalink或Publish方法时才发布资源。
-
- render
- 何时渲染页面。指定以下其中一个：
-
always- 始终将页面渲染到磁盘。这是默认值。
-
link- 不要将页面渲染到磁盘，但分配
Permalink和RelPermalink值。
-
never- 从不将页面渲染到磁盘，并将其从所有页面集合中排除。
-
示例 – 无头页面
创建一个未发布的页面，其内容和资源可以包含在其他页面中。
content/
├── headless/
│ ├── a.jpg
│ ├── b.jpg
│ └── index.md <-- 叶子包
└── _index.md <-- 首页
在 front matter 中设置构建选项：
content/headless/index.md
---
build:
list: never
publishResources: false
render: never
title: 无头页面
---+++
title = '无头页面'
[build]
list = 'never'
publishResources = false
render = 'never'
+++{
"build": {
"list": "never",
"publishResources": false,
"render": "never"
},
"title": "无头页面"
}
要在首页上包含内容和图像：
layouts/_default/home.html
{{ with .Site.GetPage "/headless" }}
{{ .Content }}
{{ range .Resources.ByType "image" }}
<img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}
{{ end }}已发布的站点将具有以下结构：
public/
├── headless/
│ ├── a.jpg
│ └── b.jpg
└── index.html
在上面的示例中，请注意：
- Hugo 没有为页面发布 HTML 文件。
- 尽管在 front matter 中将
publishResources设置为false，但 Hugo 发布了 页面资源 ，因为我们在每个资源上调用了RelPermalink方法。这是预期的行为。
示例 – 无头章节
创建一个未发布的章节，其内容和资源可以包含在其他页面中。
content/
├── headless/
│ ├── note-1/
│ │ ├── a.jpg
│ │ ├── b.jpg
│ │ └── index.md <-- 叶子包
│ ├── note-2/
│ │ ├── c.jpg
│ │ ├── d.jpg
│ │ └── index.md <-- 叶子包
│ └── _index.md <-- 分支包
└── _index.md <-- 首页
在 front matter 中设置构建选项，使用 cascade 关键字将值“级联”到子页面。
content/headless/_index.md
---
cascade:
- build:
list: local
publishResources: false
render: never
title: 无头章节
---+++
title = '无头章节'
[[cascade]]
[cascade.build]
list = 'local'
publishResources = false
render = 'never'
+++{
"cascade": [
{
"build": {
"list": "local",
"publishResources": false,
"render": "never"
}
}
],
"title": "无头章节"
}
在上面的 front matter 中，请注意，我们已将 list 设置为 local ，以便将子页面包含在局部页面集合中。
要在首页上包含内容和图像：
layouts/_default/home.html
{{ with .Site.GetPage "/headless" }}
{{ range .Pages }}
{{ .Content }}
{{ range .Resources.ByType "image" }}
<img src="{{ .RelPermalink }}" width="{{ .Width }}" height="{{ .Height }}" alt="">
{{ end }}
{{ end }}
{{ end }}已发布的站点将具有以下结构：
public/
├── headless/
│ ├── note-1/
│ │ ├── a.jpg
│ │ └── b.jpg
│ └── note-2/
│ ├── c.jpg
│ └── d.jpg
└── index.html
在上面的示例中，请注意：
- Hugo 没有为页面发布 HTML 文件。
- 尽管在 front matter 中将
publishResources设置为false，但 Hugo 正确地发布了 页面资源 ，因为我们在每个资源上调用了RelPermalink方法。这是预期的行为。
示例 – 不发布的列表
发布一个章节页面，但不发布子页面。例如，创建一个词汇表：
content/
├── glossary/
│ ├── _index.md
│ ├── bar.md
│ ├── baz.md
│ └── foo.md
└── _index.md
在 front matter 中设置构建选项，使用 cascade 关键字将值“级联”到子页面。
content/glossary/_index.md
---
build:
render: always
cascade:
- build:
list: local
publishResources: false
render: never
title: 词汇表
---+++
title = '词汇表'
[build]
render = 'always'
[[cascade]]
[cascade.build]
list = 'local'
publishResources = false
render = 'never'
+++{
"build": {
"render": "always"
},
"cascade": [
{
"build": {
"list": "local",
"publishResources": false,
"render": "never"
}
}
],
"title": "词汇表"
}
渲染词汇表：
layouts/glossary/list.html
<dl>
{{ range .Pages }}
<dt>{{ .Title }}</dt>
<dd>{{ .Content }}</dd>
{{ end }}
</dl>已发布的站点将具有以下结构：
public/
├── glossary/
│ └── index.html
└── index.html
示例 – 不列出的发布
发布章节的子页面，但不发布章节页面本身。
content/
├── books/
│ ├── _index.md
│ ├── book-1.md
│ └── book-2.md
└── _index.md
在 front matter 中设置构建选项：
content/books/_index.md
---
build:
list: never
render: never
title: 书籍
---+++
title = '书籍'
[build]
list = 'never'
render = 'never'
+++{
"build": {
"list": "never",
"render": "never"
},
"title": "书籍"
}
已发布的站点将具有以下结构：
public/
├── books/
│ ├── book-1/
│ │ └── index.html
│ └── book-2/
│ └── index.html
└── index.html
示例 – 有条件地隐藏章节
考虑此示例。一个文档站点拥有一组贡献者，他们可以访问 20 个自定义短代码。每个短代码都带有多个参数，并且需要文档供贡献者在使用时参考。
不要为短代码提供外部文档，而是包含一个在构建生产站点时隐藏的“内部”章节。
content/
├── internal/
│ ├── shortcodes/
│ │ ├── _index.md
│ │ ├── shortcode-1.md
│ │ └── shortcode-2.md
│ └── _index.md
├── reference/
│ ├── _index.md
│ ├── reference-1.md
│ └── reference-2.md
├── tutorials/
│ ├── _index.md
│ ├── tutorial-1.md
│ └── tutorial-2.md
└── _index.md
在 front matter 中设置构建选项，使用 cascade 关键字将值“级联”到子页面，并使用 target 关键字定位生产环境。
content/internal/_index.md.
cascade:
- _target:
environment: production
build:
list: never
render: never
title: 内部
title = '内部'
[[cascade]]
[cascade._target]
environment = 'production'
[cascade.build]
list = 'never'
render = 'never'
{
"cascade": [
{
"_target": {
"environment": "production"
},
"build": {
"list": "never",
"render": "never"
}
}
],
"title": "内部"
}
生产站点将具有以下结构：
public/
├── reference/
│ ├── reference-1/
│ │ └── index.html
│ ├── reference-2/
│ │ └── index.html
│ └── index.html
├── tutorials/
│ ├── tutorial-1/
│ │ └── index.html
│ ├── tutorial-2/
│ │ └── index.html
│ └── index.html
└── index.html