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

Название

Описание

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

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

metadata

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

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

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

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

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

object[]

—

resources

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

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

object

undefined

title

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

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

string

—