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

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