Файлы навигации

В любой директории с исходными файлами можно создать файл навигации _nav.yaml. В таком файле можно описать метаданные для текущего раздела, а также задать сортировку и описать метаданные дочерних разделов.

Действие каждого такого файла распространяется только на ту директорию, в которой он находится.

Метаданные раздела #

Если в директории нет индексного файла, то Собирака автоматически генерирует индексную страницу с оглавлением и использует для неё метаданные из файла навигации. В файле навигации можно указать все те же свойства, что и в обычном блоке метаданных (кроме version).

Если в директории есть индексный файл (например, _index.md), то метаданные из файла навигации игнорируются. Это поведение может измениться в будущих версиях Собираки.

Пример ниже описывает раздел из трёх статей, для которого будет сгенерирована простая страница-оглавление (при отсутствующем файле _index.md). Метаданные задают название страницы и её адрес.

permalink: /setup/
toc_title: Установка
title: Установка программы
items:
  - windows.md
  - macos.md
  - linux.md

Сортировка и метаданные подразделов #

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

Чтобы задать порядок разделов, перечислите имена файлов:

items:
  - windows.md
  - macos.md
  - linux.md

Если необходимо, в каждом пункте можно указать после двоеточия название страницы — аналог свойства title:

items:
  - windows.md: Установка в Windows
  - macos.md: Установка в macOS
  - linux.md: Установка в Linux

Также можно указать вложенный словарь с любыми метаданными (кроме version).

items:
  - windows.md:
      title: Установка в Windows
      toc_title: Windows
  - macos.md:
      title: Установка в macOS
      toc_title: macOS
  - linux.md:
      title: Установка в Linux
      toc_title: Linux