Комментарии и метаданные

Обновлена October 7, 2025

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

Метаданные

Метаданные можно добавить в формате YAML в начало файла для настроек отображения страницы.

Пример:

---
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="..."/>

string

—

keywords

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

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

string[]

—

interface

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

Пример с отключением оглавления на странице

---
interface:
  toc: false
---

object

undefined

resources

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

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

Важно

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

object

undefined

title

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

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

string

—

Была ли статья полезна?

Фрагменты кода

Переменные и шаблоны