Параметры сборки
Они хранятся в зарезервированном объекте Front Matter с именем _build
со следующими значениями по умолчанию:
_build:
render: always
list: always
publishResources: true
render
Если always
, страница будет рассматриваться как опубликованная, содержащая свои выделенные выходные файлы (index.html
, и т.д.) и постоянную ссылку.
Мы расширили это свойство с логического до перечисления в Hugo 0.76.0. Допустимые значения:
- never
- Страница не будет включена ни в одну коллекцию страниц.
- always (default)
- Страница будет отображена на диск и получит ссылку
RelPermalink
и т.д. - link
- Страница не будет отображаться на диск, но получит ссылку
RelPermalink
.
list
Обратите внимание, что в Hugo 0.68.0 мы расширили это свойство с логического до перечисления.
Допустимые значения:
- never
- Страница не будет включена ни в одну коллекцию страниц.
- always (default)
- Страница будет включена во все коллекции страниц, например:
site.RegularPages
,$page.Pages
. - local
- Страница будет включена в любую коллекцию локальных страниц, например:
$page.RegularPages
,$page.Pages
. Одним из вариантов использования этого может быть создание разделов с полностью управляемым, но без заголовка содержимого.
Если true
, страница будет рассматриваться как часть коллекций проекта и, при необходимости, возвращаться методами листинга Hugo (.Pages
, .RegularPages
и т.д.).
publishResources
Если задано значение true
, будут опубликованы пакеты ресурсов.
Установка этого значения в false по-прежнему будет публиковать ресурсы по запросу (когда ресурс .Permalink
или .RelPermalink
вызывается из шаблонов), но пропускает остальные.
Иллюстративные варианты использования
Не публикуемая страница
Проекту нужен файл содержимого «Кто мы» для Front Matter и тела, которые будут использоваться на главной странице, но нигде больше.
# content/who-we-are.md`
title: Who we are
_build:
list: false
render: false
{{/* layouts/index.html */}}
<section id="who-we-are">
{{ with site.GetPage "who-we-are" }}
{{ .Content }}
{{ end }}
</section>
Листинг страниц без их публикации
Веб-сайт должен продемонстрировать несколько из сотни «отзывов», доступных в виде файлов содержимого, без публикации каких-либо из них.
Чтобы избежать установки параметров сборки для каждой характеристики, можно использовать cascade
в файле содержимого раздела отзывов.
#content/testimonials/_index.md
title: Testimonials
# section build options:
_build:
render: true
# children build options with cascade
cascade:
_build:
render: false
list: true # default
{{/* layouts/_defaults/testimonials.html */}}
<section id="testimonials">
{{ range first 5 .Pages }}
<blockquote cite="{{ .Params.cite }}">
{{ .Content }}
</blockquote>
{{ end }}
</section>