---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://3y3.dev/en/index-yfm.md
  - href: en/index-yfm.md
    type: text/markdown
    title: Markdown version
  - href: llms.txt
    type: text/markdown
    title: llms.txt
updatedAt: '2025-11-20T11:13:39.000Z'
---
> **Documentation Index:** Fetch the complete configuration index at https://3y3.dev/en/llms.txt


# Yandex Flavored Markdown
**Yandex Flavored Markdown (YFM)** is a Markdown dialect and a set of tools for transforming Markdown to HTML in real time and [building](https://3y3.dev/en/tools/docs/index.md) complete documentation projects.

* Corresponds to [CommonMark Spec](https://spec.commonmark.org/).
* Includes its own [set of plugins](https://3y3.dev/en/plugins/index.md) with additional features and markup elements.
* [Fast](https://www.npmjs.com/package/markdown-it#benchmark).
* Expandable: you can [add](https://3y3.dev/en/plugins/import.md) any plugin for markdown-it or [write your own](https://github.com/markdown-it/markdown-it/tree/master/docs).
* Safe: HTML is escaped by default.
* Uses dynamic validation.
* Allows you to build a documentation project.

## Syntax {#syntax}

The Yandex Flavored Markdown syntax is based on [CommonMark Spec](https://spec.commonmark.org/) and has been supplemented with unique elements from other markup languages and template engines.

In particular:

* [Notes](https://3y3.dev/en/syntax/notes.md)
* [Cuts and tabs](https://3y3.dev/en/syntax/cuts-tabs.md)
* [Video](https://3y3.dev/en/syntax/media.md#video)
* [Variables](https://3y3.dev/en/syntax/vars.md)
* [Reusable content](https://3y3.dev/en/syntax/includes.md)

For more information about all markup elements, see [Syntax](https://3y3.dev/en/syntax/index.md).

## Creating documentation projects {#project}

[Builder](https://3y3.dev/en/tools/docs/index.md) allows you to build a complete documentation project: with navigation, internal links, and full support for Yandex Flavored Markdown.

A built project is a set of static HTML files that can be viewed locally or on a host, in GitHub Pages, or in [S3](https://3y3.dev/en/tools/docs/publish-s3.md). It may include:

* [Table of contents](https://3y3.dev/en/project/toc.md).

* [Leading pages](https://3y3.dev/en/project/leading-page.md) for quick navigation.

* [Variable presets](https://3y3.dev/en/project/presets.md) to support multiple versions of documentation from the same source files.

* [Reusable content](https://3y3.dev/en/syntax/includes.md).

* Custom display settings:
    * Wide format.
    * Current article navigation.
    * Dark theme.
    * Text size.

  You can try changing the settings right now: click ![settings-icon](./_images/user-settings.png) in the upper-right corner.

In addition to building all files in HTML, you can build to a [single-page](https://3y3.dev/en/tools/docs/singlepage.md) and in [YFM](https://3y3.dev/en/tools/docs/build.md#yfm).