summaryrefslogtreecommitdiffstats
path: root/docs/content/en/content-management/build-options.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2020-10-06 11:19:31 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2020-10-06 14:06:10 +0200
commit634938908ec8f393b9a05d26b4cfe19ca7abb0d0 (patch)
tree4726d31ba07f7391bade0b21a43694c29278fc69 /docs/content/en/content-management/build-options.md
parentc63db7f1f6774a2d661af1d8197c6fe377e3ad25 (diff)
pagemeta: Make BuildConfig.Render an enum
Allowing links on pages without rendering them. Fixes #7783
Diffstat (limited to 'docs/content/en/content-management/build-options.md')
-rw-r--r--docs/content/en/content-management/build-options.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/content/en/content-management/build-options.md b/docs/content/en/content-management/build-options.md
index b01568d39..93da7c421 100644
--- a/docs/content/en/content-management/build-options.md
+++ b/docs/content/en/content-management/build-options.md
@@ -20,13 +20,24 @@ They are stored in a reserved Front Matter object named `_build` with the follow
```yaml
_build:
- render: true
+ render: always
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.
+If `always`, the page will be treated as a published page, holding its dedicated output files (`index.html`, etc...) and permalink.
+
+{{< new-in "0.76.0" >}} We extended this property from a boolean to an enum in Hugo 0.76.0. Valid values are:
+
+never
+: The page will not be included in any page collection.
+
+always (default)
+: The page will be rendered to disk and get a `RelPermalink` etc.
+
+link
+: The page will be not be rendered to disk, but will get a `RelPermalink`.
#### list