Разводящая страница

Для быстрой навигации по документу вы можете оформить корневую страницу в виде сетки с ссылками на основные разделы index.yaml.

Для небольших документов допустимо использовать упрощенный вариант — обычную страницу с описанием и ссылками index.md.

Пример:
Оформление разводящей страницы документации сервиса Yandex Compute Cloud.

Структура

Стандартная структура файла разводящей страницы index.yaml имеет вид:

title: Имя документа
description: Описание документа
meta:
  title: Метаданные
  noIndex: true
links:
- title: Первый раздел
  description: Описание первого раздела
  href: path/to/file
- title: Второй раздел
  description: Описание второго раздела
  href: path/to/file

• title — название документа. Отображается в оглавлении над списком всех разделов.
• description — описание документа.
• meta— метаданные.
• links — группирующий элемент. Для каждого раздела внутри него задается:
  • title — название раздела. Отображается как имя ссылки.
  • description— описание раздела.
  • href — относительный путь до файла без указания расширения.

Условия видимости элементов

Отдельные разделы можно отображать или не отображать на разводящей странице в зависимости от значений переменных. Для описания условий видимости используется параметр when.

Доступные операторы сравнения: ==, !=, <, >, <=, >=.

- title: Раздел с условным вхождением
  description: Описание раздела
  href: path/to/conditional/file.md
  when: version == 12

Подстановки и условные операторы

Название и описание документа и ссылок поддерживают подстановки и условные операторы.

title: "not_var{{ title }}"
description: "{% if version == 10 %}not_var{{ description_legacy }}{% else %}not_var{{ description }}{% endif %}"
meta:
  title: "not_var{{ meta_title }}"
links:
- title: "not_var{{ link_title }}"
  description: "not_var{{ link_description }}"
  href: path/to/conditional/file.md