Навигация

Это, наверное, самая главная функция MkDocs. И именно поэтому у неё огромное количество возможностей для кастомизации. Я расскажу лишь о тех, которые использую сам.

Базовое меню

Чтобы создать навигационное меню, нужно указать свойство nav и в списке передать пути до Markdown файлов:

nav:
  - mkdocs/navigation.md

Названия пунктов меню

По умолчанию в качестве названия пункта меню используется заголовок первого уровня в файле Markdown (один #). Чтобы написать другое название, его можно указать перед путём к файлу, например:

nav:
  - Навигация: mkdocs/navigation.md

Секции

Для создания структуры в навигационном меню, можно создавать секции, раскрывающиеся списки. Для этого в списке в nav нужно передать элемент-список без указания пути:

nav:
  - "№0: MkDocs":
      - mkdocs/navigation.md

Индексные страницы секций

С помощью плагина navigation.indexes секции можно сделать кликабельными и поместить в них какое-либо содержимое. Для этого нужно добавить плагин в mkdocs.yml и добавить файл index.md в список секции:

theme:
  features:
    - navigation.indexes
nav:
  - "№0: MkDocs":
      - mkdocs/index.md
      - mkdocs/navigation.md