Documentation project

YFM supports creating and maintaining documentation projects of any size.

Example: Yandex.Cloud documentation.

Project structure

In the most basic case, a project consists of a table of contents file and files with content.

To optimize the documenting process and improve the appearance of pages, you can additionally include:


|-- .yfm (Configuration file)
|-- toc.yaml (Table of contents)
|-- presets.yaml (Variable presets)
|-- index.yaml (Leading page)
|-- pages (Content files)
|-- _assets (Folder with images)
    |-- image1.png
    |-- image2.png
|--_includes (Folder with files to be reused)
In this article: