If true, the page will be treated as a published page, holding its dedicated output files (index.html, etc…) and permalink.
Note that we extended this property from a boolean to an enum in Hugo 0.68.0.
Valid values are:
The page will not be included in any page collection.
The page will be included in all page collections, e.g. site.RegularPages, $page.Pages.
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.
If true, the page will be treated as part of the project’s collections and, when appropriate, returned by Hugo’s listing methods (.Pages, .RegularPages etc…).
If set to true the Bundle’s Resources 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.
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.