Вставка произвольного контента (includers)

Можно включить в документацию произвольный контент через инклюдеры (от английского includers) — специальный механизм расширения документационного проекта на этапе сборки дополнительными файлами.

Подключение

Инклюдеры подключаются в поле includers у пункта оглавления с параметром include:

items:
  - name: <item-name>
    include:
      path: <path-where-to-include>
      includers:
        - name: <name-of-the-first-includer>
          <includer-parameter>: <includer-parameter-value>
        - name: <name-of-the-second-includer>
        - name: <name-of-the-third-includer>
      mode: link

1. Объект include должен иметь поле path с путем, откуда контент будет включен.

2. Параметр mode должен иметь значение link или быть пропущен, link является значением по умолчанию.

3. Параметр includers должен содержать список includer-объектов, которые будут вызваны последовательно в указанном порядке.

4. Каждый includer-объект должен содержать поле name с типом инклюдера:

   • generic — вставка произвольных Markdown-файлов в структуру проекта;

   • openapi — автогенерация статей на основе OpenAPI-спецификаций;

   • unarchive — распаковка tar-файла перед выполнением других инклюдеров.

5. У разных типов инклюдеров могут быть собственные параметры, которые указываются в includer-объекте.