Метаданные статьи

Статья обновлена 21 июля 2026 г.

Метаданные — элементы разметки, которые используются для хранения в исходном тексте настроек конкретной статьи, информации для SEO или об авторах документа. Они не отображаются в собранной статье, но могут влиять на её сборку.

В md-файлы метаданные добавляются в формате YAML в начало файла (эта часть файла называется frontmatter).

В yaml-файлы c Page constructor страницами и разводящими — прямо в корневой объект.

Пример:

---
title: Заголовок
description: Описание
---

# Заголовок статьи

Текст статьи ......

Поддерживаемые параметры:

Название

Описание

Тип и значение по умолчанию

alternate

Ссылки на другие языковые версии страницы.

Каждая ссылка прописывается в <link rel="alternate" hreflang="..." href="..."/>.

На этапе сборки массив автоматически дополняется совпадающими ссылками из других языков документации.

string[]

—

canonical

Каноническая ссылка для индексации страницы.

Прописывается в <link rel="canonical" href="..."/>.

Если явно не указана, то на этапе сборки автоматически прописывается путь до страницы.

string

—

copyright

Указание владельца контента страницы.

Прописывается в <meta name="copyright" content="..."/>.

string

—

description

Мета-описание страницы.

Прописывается в <meta name="description" content="..."/> и в llms.txt.

string

—

keywords

Список ключевых слов страницы для поисковых роботов.

Прописывается в <meta name="keywords" content="key1,key2,..."/>.

string[]

—

interface

Секция с настройками отображения интерфейса. Переопределяет установленные в одноимённой секции .yfm настройки для текущей страницы.

Пример с отключением оглавления на странице
---
interface:
  toc: false
---

object

—

metadata

Список с описанием произвольных метаполей статьи.

Список содержит объекты вида:

metadata:
  - name: name 1
    content: content 1
  - http-equiv: http-equiv 2
    content: content 2
  - property: property 3
    content: content 3
...

на основе которых формируется набор тегов:

<meta name="name 1" content="content 1"/>
<meta http-equiv="http-equiv 2" content="content 2">
<meta property="property 3" content="content 3">

Примеры полей и их возможных значений можно найти в статье об организации контентной аналитики.

object[]

—

resources

Секция для управления ресурсами страницы.

Переопределяет настройки resources, установленные в секции resources .yfm.

Важно

Доступно только расширение списка значений csp.

object

—

title

Мета-заголовок страницы.

Прописывается в <meta name="title" content="..."/>.

string

—

Смотри также: Ajv схема метаданных статьи

Предыдущая
Редиректы
Следующая
Оглавление страницы документации