Spec-Zone.ru › Jekyll 4

Вступительная информация

Любой файл, содержащий блок вступительной информации YAML, будет обрабатываться Jekyll как специальный файл. Вступительная информация должна быть первой в файле и должна быть представлена в виде корректного YAML, заключенного в тройные дефисы. Вот базовый пример:

---
layout: post
title: Blogging Like a Hacker
---

Между этими тройными дефисами вы можете установить предопределённые переменные (см. справочник ниже) или даже создавать свои собственные. Эти переменные будут доступны для доступа с помощью тегов Liquid как дальше в файле, так и в любых макетах или включениях, от которых зависит данная страница или запись.

Предупреждение о кодировке символов UTF-8

Если вы используете кодировку UTF-8, убедитесь, что в ваших файлах отсутствуют символы заголовка BOM, иначе Jekyll вызовет серьёзные проблемы. Это особенно актуально, если вы используете Jekyll в Windows.

Переменные вступительной информации необязательны

Если вы хотите использовать теги и переменные Liquid, но не нуждаетесь ни в чём в вступительной информации, просто оставьте её пустой! Набор тройных дефисов без чего-либо между ними всё равно заставит Jekyll обработать ваш файл. (Это полезно для таких вещей, как CSS и RSS-каналы!)

Предопределённые глобальные переменные

Существует ряд предопределённых глобальных переменных, которые вы можете установить в вступительной информации страницы или записи.

Переменная Описание

layout

Если установлено, это указывает на файл макета, который необходимо использовать. Используйте имя файла макета без расширения. Файлы макетов должны быть размещены в каталоге _layouts.

  • Использование null создаст файл без использования файла макета. Это переопределяется, если файл является записью/документом и имеет макет, определённый в параметрах по умолчанию вступительной информации.
  • Начиная с версии 3.5.0, использование none в записи/документе создаст файл без использования файла макета независимо от параметров по умолчанию вступительной информации. Использование none на странице заставит Jekyll попытаться использовать макет с именем "none".

permalink

Если вам нужно, чтобы обработанные URL-адреса записей блога отличались от стандартного стиля сайта (по умолчанию /year/month/day/title.html), вы можете установить эту переменную, и она будет использоваться в качестве конечного URL-адреса.

published

Установите значение false, если вы не хотите, чтобы конкретная запись отображалась при генерации сайта.

Отображение записей, отмеченных как черновики

Чтобы предварительно просмотреть черновики страниц, запустите `jekyll serve` или `jekyll build` со значением `--unpublished`. Jekyll также имеет удобную функцию черновиков, специально разработанную для записей блога.

Пользовательские переменные

Вы также можете установить свои собственные переменные вступительной информации, к которым можно получить доступ в Liquid. Например, если вы установите переменную food, вы можете использовать её на своей странице:

---
food: Pizza
---

<h1>{{ page.food }}</h1>

Предопределённые переменные для записей

Эти переменные доступны сразу для использования в вступительной информации записи.

Переменная Описание

date

Дата здесь переопределяет дату из имени записи. Это может использоваться для обеспечения правильной сортировки записей. Дата указывается в формате YYYY-MM-DD HH:MM:SS +/-TTTT; часы, минуты, секунды и смещение часового пояса необязательны.

category

categories

Вместо размещения записей в папках вы можете указать одну или несколько категорий, к которым относится запись. При генерации сайта запись будет вести себя так, как если бы она была установлена с этими категориями обычно. Категории (множественное число) могут быть заданы как список YAML или через пробел.

tags

Аналогично категориям, можно добавить одну или несколько тегов к записи. Также, как и категории, теги могут быть заданы как список YAML или через пробел.

Не повторяйте себя

Если вы не хотите повторять часто используемые переменные вступительной информации, определите значения по умолчанию для них и переопределите их только там, где необходимо (или не переопределяйте вообще). Это работает как для предопределённых, так и для пользовательских переменных.

© 2020 Jekyll Core Team and contributors
Licensed under the MIT license.
https://jekyllrb.com/docs/front-matter/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API