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

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

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

Пример разводящей страницы

Структура

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

title: Имя документа
description: Описание документа
meta:
  title: Метаданные
  noIndex: true
links:
- title: Первый раздел
  description: Описание первого раздела
  href: path/to/file.md
- title: Второй раздел
  description: Описание второго раздела
  href: path/to/file.md
  • title — название документа. Отображается в оглавлении над списком всех разделов.
  • description — описание документа.
  • metaметаданные.
  • links — группирующий элемент. Для каждого раздела внутри него задается:
    • title — название раздела. Отображается как имя ссылки.
    • description— описание раздела.
    • href — относительный путь до файла.

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

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

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

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