Front Matter

3 хвилин(и)

Front matter — це код YAML, що розташований між трьома тире на початку кожного файлу і надає важливі параметри управління для нашого контенту. Наприклад, front matter дозволяє забезпечити, щоб існуючі посилання залишалися робочими для сторінок, які переміщуються або видаляються зовсім. Ця сторінка пояснює функції, які наразі доступні для front matter в Istio.

Наступний приклад показує front matter з усіма необхідними полями, заповненими заповнювачами:

---
title: <title>
description: <description>
weight: <weight>
keywords: [<keyword1>,<keyword2>,...]
aliases:
    - <previously-published-at-this-URL>
---

Ви можете скопіювати наведену вище структуру і замінити всі заповнювачі на відповідні значення для вашої сторінки.

Обовʼязкові поля front matter

Нижченаведена таблиця показує описи всіх обовʼязкових полів:

Поле	Опис
`title`	Назва сторінки.
`description`	Короткий опис контенту на сторінці.
`weight`	Порядок сторінки відносно інших сторінок у теці.
`keywords`	Ключові слова на сторінці. Hugo використовує цей список для створення посилань у розділі “Див. також”.
`aliases`	Колишні URL-адреси, за якими була опублікована сторінка. Див. Перейменування, переміщення або видалення сторінок нижче для отримання деталей.

Перейменування, переміщення або видалення сторінок

Коли ви переміщаєте сторінки або видаляєте їх повністю, потрібно забезпечити, щоб наявні посилання на ці сторінки залишалися робочими. Поле aliases у front matter допомагає вам виконати цю вимогу. Додайте шлях до сторінки перед переміщенням або видаленням до поля aliases. Hugo реалізує автоматичні перенаправлення зі старої URL-адреси на нову для наших користувачів.

На цільовій сторінці, яка є сторінкою, на яку ви хочете, щоб користувачі потрапляли, додайте <path> оригінальної сторінки до front matter наступним чином:

aliases:
    - <path>

Наприклад, ви могли знайти нашу сторінку FAQ раніше за адресою /help/faq. Щоб допомогти нашим користувачам знайти сторінку FAQ, ми перемістили сторінку на один рівень вище до /faq/ і змінили front matter наступним чином:

---
title: Часті питання
description: Питання, що часто задаються.
weight: 13
aliases:
    - /help/faq
---

Зміна вище дозволяє будь-якому користувачеві отримати доступ до FAQ, коли вони відвідують https://istio.io/faq/ або https://istio.io/help/faq/.

Підтримуються кілька перенаправлень, наприклад:

---
title: Часті питання
description: Питання, що часто задаються.
weight: 13
aliases:
    - /faq
    - /faq2
    - /faq3
---

Додаткові поля front matter

Однак Hugo підтримує багато полів front matter, і ця сторінка охоплює лише ті, що реалізовані на istio.io.

Нижченаведена таблиця показує найбільш часто використовувані додаткові поля:

Поле	Опис
`linktitle`	Скорочена версія назви, яка використовується для посилань на сторінку.
`subtitle`	Підзаголовок, що відображається під основною назвою.
`icon`	Шлях до зображення, яке зʼявляється поруч з назвою.
`draft`	Якщо `true`, сторінка не відображається в навігації сайту.
`skip_byline`	Якщо `true`, Hugo не показує підпис під основною назвою.
`skip_seealso`	Якщо `true`, Hugo не генерує розділ “Див. також” для сторінки.

Деякі поля front matter контролюють автоматично згенеровану таблицю вмісту (ToC). Нижченаведена таблиця показує поля та пояснює, як їх використовувати:

Поле	Опис
`skip_toc`	Якщо `true`, Hugo не генерує ToC для сторінки.
`force_inline_toc`	Якщо `true`, Hugo вставляє автоматично згенерований ToC у текст замість бічної панелі праворуч.
`max_toc_level`	Встановлює рівні заголовків, що використовуються в ToC. Значення можуть коливатися від 2 до 6.
`remove_toc_prefix`	Hugo видаляє цей рядок з початку кожного запису в ToC.

Деякі поля front matter застосовуються лише до так званих bundle pages. Ви можете визначити bundle pages за тим, що їхні імена файлів починаються з підкреслення _, наприклад, _index.md. В Istio ми використовуємо bundle pages як наші сторінки розділів. Нижченаведена таблиця показує поля front matter, що стосуються bundle pages.

Поле	Опис
`skip_list`	Якщо `true`, Hugo автоматично не генерує вміст розділу сторінки.
`simple_list`	Якщо `true`, Hugo використовує простий список для автоматично згенерованого вмісту сторінки розділу.
`list_below`	Якщо `true`, Hugo вставляє автоматично згенерований вміст нижче вручну написаного контенту.
`list_by_publishdate`	Якщо `true`, Hugo сортує автоматично згенерований вміст за датою публікації, а не за вагою.

Аналогічно, деякі поля front matter застосовуються специфічно до блог-постів. Нижченаведена таблиця показує ці поля:

Поле	Опис
`publishdate`	Дата оригінальної публікації посту
`last_update`	Дата, коли пост востаннє отримав значну ревізію
`attribution`	Необовʼязкове імʼя автора посту
`twitter`	Необовʼязковий Twitter-акаунт автора посту
`target_release`	Випуск, використовуваний для цього блогу. Зазвичай це значення є поточним основним випуском Istio на момент написання або оновлення блогу.