mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
c494c37a45
20d77860b Remove the calibre image action 58f53654d Improve image metadata formatting (#1067) c569f3657 Update theme 80e6d362e Update theme d5806cca5 Update theme efc5cb227 Remove broken link on "where" page (#1058) 443266076 Comments Alternatives (#1036) 9b480ebb7 Fix typo 1402365ee Fix included typo in build-options.md 3b5a76de1 Update index.md 1196c7695 Update index.md 1887ea1ed Update index.md d0666e74e Hugo 0.68.3 d514cfac9 Merge branch 'temp683' 49e57362b releaser: Add release notes to /docs for release of 0.68.3 fa0ac3bf1 Merge branch 'temp682' 46993c209 Release 0.68.2 4c8d6d242 releaser: Add release notes to /docs for release of 0.68.2 9694f4d36 Update index.md 368a03754 Update index.md 0d997010c Merge branch 'temp681' 24138a9cd releaser: Add release notes to /docs for release of 0.68.1 7dd6cc788 Update index.md b6125b4a8 Update build-options.md a2dead37a Release 0.68.0 7cff41348 Merge branch 'temp680' b3b37959c releaser: Add release notes to /docs for release of 0.68.0 0f98184b0 Some minify configuration adjustments 02219f787 Add minify config efeea7be0 Allow headless bundles to list pages via $page.Pages and $page.RegularPages 7950d0ad1 Mention `resources` folder in the "Directory structure" docs. git-subtree-dir: docs git-subtree-split: 20d77860b2a992b4917af75a657419b19baafa43
106 lines
2.9 KiB
Markdown
106 lines
2.9 KiB
Markdown
---
|
|
title: Build Options
|
|
linktitle: Build Options
|
|
description: Build options help define how Hugo must treat a given page when building the site.
|
|
date: 2020-03-02
|
|
publishdate: 2020-03-02
|
|
keywords: [build,content,front matter, page resources]
|
|
categories: ["content management"]
|
|
menu:
|
|
docs:
|
|
parent: "content-management"
|
|
weight: 31
|
|
weight: 31 #rem
|
|
draft: false
|
|
aliases: [/content/build-options/]
|
|
toc: true
|
|
---
|
|
|
|
They are stored in a reserved Front Matter object named `_build` with the following defaults:
|
|
|
|
```yaml
|
|
_build:
|
|
render: true
|
|
list: always
|
|
publishResources: true
|
|
```
|
|
|
|
#### render
|
|
If true, the page will be treated as a published page, holding its dedicated output files (`index.html`, etc...) and permalink.
|
|
|
|
#### list
|
|
|
|
Note that we extended this property from a boolean to an enum in Hugo 0.58.0.
|
|
|
|
Valid values are:
|
|
|
|
never
|
|
: The page will not be included in any page collection.
|
|
|
|
always (default)
|
|
: The page will be included in all page collections, e.g. `site.RegularPages`, `$page.Pages`.
|
|
|
|
local
|
|
: The page will be included in any _local_ page collection, e.g. `$page.RegularPages`, `$page.Pages`. One use case for this would be to create fully navigable, but headless content sections. {{< new-in "0.58.0" >}}
|
|
|
|
#### publishResources
|
|
|
|
If set to true the [Bundle's Resources]({{< relref "content-management/page-bundles" >}}) will be published.
|
|
Setting this to false will still publish Resources on demand (when a resource's `.Permalink` or `.RelPermalink` is invoked from the templates) but will skip the others.
|
|
|
|
{{% note %}}
|
|
Any page, regardless of their build options, will always be available using the [`.GetPage`]({{< relref "functions/GetPage" >}}) methods.
|
|
{{% /note %}}
|
|
|
|
------
|
|
|
|
### Illustrative use cases
|
|
|
|
#### Not publishing a page
|
|
Project needs a "Who We Are" content file for Front Matter and body to be used by the homepage but nowhere else.
|
|
|
|
```yaml
|
|
# content/who-we-are.md`
|
|
title: Who we are
|
|
_build:
|
|
list: false
|
|
render: false
|
|
```
|
|
|
|
```go-html-template
|
|
{{/* layouts/index.html */}}
|
|
<section id="who-we-are">
|
|
{{ with site.GetPage "who-we-are" }}
|
|
{{ .Content }}
|
|
{{ end }}
|
|
</section>
|
|
```
|
|
|
|
#### Listing pages without publishing them
|
|
|
|
Website needs to showcase a few of the hundred "testimonials" available as content files without publishing any of them.
|
|
|
|
To avoid setting the build options on every testimonials, one can use [`cascade`]({{< relref "/content-management/front-matter#front-matter-cascade" >}}) on the testimonial section's content file.
|
|
|
|
```yaml
|
|
#content/testimonials/_index.md
|
|
title: Testimonials
|
|
# section build options:
|
|
_build:
|
|
render: true
|
|
# children build options with cascade
|
|
cascade:
|
|
_build:
|
|
render: false
|
|
list: true # default
|
|
```
|
|
|
|
```go-html-template
|
|
{{/* layouts/_defaults/testimonials.html */}}
|
|
<section id="testimonials">
|
|
{{ range first 5 .Pages }}
|
|
<blockquote cite="{{ .Params.cite }}">
|
|
{{ .Content }}
|
|
</blockquote>
|
|
{{ end }}
|
|
</section>
|