Generic

Статья создана

Обновлена 5 февраля 2026 г.

Примечание

Generic includer включен по умолчанию.

Generic — это встроенный includer, который позволяет автоматически включать Markdown-файлы в структуру документации без ручного перечисления каждого заголовка в toc.yaml.

Пример использования

Документация находится в директории doc_root. Сгенерированный контент нужно положить в директорию doc_root/gen_docs.

Добавим в doc_root/toc.yaml generic includer.

# doc_root/toc.yaml
title: documentation
href: index.yaml
items:
  - name: docs
    include:
      path: gen_docs # путь к директории с .md файлами для сгененированного контента
      includers: # подключение generic includer
        - name: generic
          autotitle: true   # опционально: при false, проставляет в структуру название md-файлов, при true — название заголовков, по умолчанию true
      mode: link

Укажем сгенерированную страницу на разводящей в doc_root/index.yaml.

# doc_root/index.yaml
title: documentation
links:
  - title: docs # название файла
    href: gen_docs/ # путь к директории с .md файлами для сгененированного контента

Была ли статья полезна?

Автогенерация и интеграция документации

Open API