Заголовок YAML («YAML front matter»)

Помимо разметки самого текста, часто бывает необходимо хранить в документе техническую информацию о самом документе (например язык содержимого, дату создания, автора и т.д.). Для таких целей хорошо зарекомендовал себя подход с использованием вступительной части на YAML. Такой подход широко используется во многих статических генераторах Web-сайтов (Jekyll, Hugo, Assemble, Eleventy).

Разметка YAML основана на пробелах и переносах строк. YAML-документ состоит из полей (пар ключ-значение), располагающихся на отдельных строках. Допускаеться неограниченная вложенность полей. Для обозначения вложенности необходимо более 1 пробела (для читаемости рекомендуется 2 и более). Более подробное описание синтаксиса YAML.

Общие правила YAML

  • YAML-документ отделяется тремя дефисами в начале и в конце;

  • пары ключ-значение располагаются на отделных строках;

  • табы запрещены;

  • комментарии начинаются с символа #.

Пример

---
type: post
title: "О Сарасвати Тхакуре"
authors: 
  - Бхакти Судхир Госвами
date: 2012-02-12
lang: ru
location: Чианг Май
audio: https://youtube/?watch=...
image: 
  desktop: sarswati-thakur.jpg
  alt: Сарсвати Тхакур с учениками
slug: ru-2012-02-12-about-saraswati-thakur
tags:
  - Сарасвати Тхакур
translators:
  - Амия Синдху Дас
transcribers:
  - Амия Синдху Дас
---

Поддерживаемые поля

type

Строка.

Тип сущности. Допустимые значения: post, category, playlist.

title

Строка.

Название лекции, статьи, книги. Оборачивайте в двойные кавычки.

authors

Список.

Авторы текста, или спикеры.

date

Строка.

Дата записи аудио, публикации статьи в формате гггг-мм-дд.

description

Строка.

SEO-описание, не больше 200 символов. Оборачивайте в двойные кавычки

lang

Строка.

Язык содержимого, 2-имвольный код в стандарте ISO 639-1.

draft

Строка (true, false)

draft: true означает, что текст не готов к публикации.

location

Строка.

Место записи лекции (город, страна).

audio

Строка.

URL аудиозаписи, или относительный путь к локальному файлу.

video

Строка.

URL видеозаписи, или относительный путь к локальному файлу.

editors

Список.

Список редакторов.

---
editors:
  - John Doe
  - Simon Peters
---

translators

Список.

Список переводчиков.

---
translators:
  - John Doe
  - Simon Peters
---

transcribers

Список.

Список создателей транскрипции.

---
transcribers:
  - John Doe
  - Simon Peters
---

image

Обьект.

Описание изображения, которое может применяться в качестве изображения записи:

---
image: 
  desktop: sarswati-thakur.jpg
  alt: Сарсвати Тхакур с учениками
---

slug

Строка.

Уникальная строка идентификатор, которая будет отображаться в URL страницы (в kebab-case).

tags

Список.

Список тегов.

---
tags:
  - tag 1
  - tag 2
---

Поля для типа "post"

---
type: post
title: О Сарасвати Тхакуре
authors: 
  - Бхакти Судхир Госвами
date: 2012-02-12
lang: ru
location: Чианг Май
audio: https://youtube/?watch=...
image: 
  desktop: sarswati-thakur.jpg
  alt: Сарсвати Тхакур с учениками
slug: ru-2012-02-12-about-saraswati-thakur
tags:
  - Сарасвати Тхакур
translators:
  - Амия Синдху Дас
transcribers:
  - Амия Синдху Дас
---

Поля для типа "category", "playlist"

---
type: category
title: 2012
lang: ru
image: 
  desktop: ru_2012.jpg
---
PreviousСтруктура документаNextПунктуация