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

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