Syntax

Diplodoc uses Yandex Flavored Markdown (YFM) syntax — a Markdown dialect with an additional set of tools for transforming Markdown into HTML and building documentation projects.

Features:

• Compatibility with the CommonMark Spec standard.
• The ability to connect third-party markdown-it plugins.
• Security: HTML is escaped by default.
• Dynamic validation.
• Building a documentation project.

The following are used for formatting:

• basic markup;
• links;
• lists;
• simple and multiline tables;
• notes;
• cuts, tabs, and radio buttons;
• images and videos;
• code fragments;
• tooltips;
• variables.

In addition to the elements included in the package, you can connect additional features via markdown-it plugins.