Документационный проект

Статья создана
Обновлена 20 ноября 2025 г.

YFM позволяет создавать и поддерживать документационные проекты.

Пример: документация Yandex.Cloud.

Структура проекта

Базовый проект включает:

Рекомендуемые дополнительные элементы:

Пример структуры проекта

input-folder
|-- .yfm # файл конфигурации
|-- toc.yaml # оглавление
|-- presets.yaml # пресеты переменных
|-- index.yaml # разводящая страница
|-- pages # файлы с контентом
    |-- faq.md
    |-- how-to.md
|-- _assets # каталог с изображениями
    |-- image1.png
    |-- image2.png
|-- _includes # каталог с файлами для переиспользования
    |-- faq_shared_block.md
Предыдущая
Кастомизация Mermaid-диаграмм
Следующая
Оглавление