Landing page

For quick navigation through the document, you can design the page as a grid with links to the main sections.

Example: design of a leading page for the Yandex Compute Cloud service documentation.

Structure

The standard structure of the leading page YAML file is as follows:

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

• title — document title. It is displayed in the table of contents above the list of all sections.
• description — document description.
• meta — metadata.
• links — grouping element. For each section within it, the following is specified:
  • title — section title. Displayed as the link name.
  • description — section description.
  • href — relative path to the file without specifying the extension.

Document and section descriptions do not support Markdown markup.

Opening links in a new tab

By default, all relative links on the leading page open in the current browser tab, while all absolute links open in a new tab. This behavior can be changed using the target parameter:

• _self — the link will open in the current tab,
• _blank — the link will open in a new tab.

- title: Абсолютная ссылка
  href: https://github.com
  target: _self
- title: Отдельный раздел в документации
  href: ./some-internal-page/
  target: _blank

Element visibility conditions

Individual sections can be shown or hidden on the leading page depending on the values of variables. The when parameter is used to describe visibility conditions.

Available comparison operators: ==, !=, <, >, <=, >=.

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

Substitutions and conditional operators

The title and description of the document and links support substitutions and conditional operators.

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

See also: Ajv schema for leading pages