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:

• A leading page for quick navigation.
• Variable presets to support multiple versions of documentation from the same source files.
• A configuration file with project settings.
• Folders for reusing content and storing images.

Example

input-folder
|-- .yfm (Configuration file)
|-- toc.yaml (Table of contents)
|-- presets.yaml (Variable presets)
|-- index.yaml (Leading page)
|-- pages (Content files)
    |-- faq.md
    |-- how-to.md
|-- _assets (Folder with images)
    |-- image1.png
    |-- image2.png
|--_includes (Folder with files to be reused)
    |-- faq_shared_block.md