---
title: Syntax guide
description: Learn about the Markdown syntax used in docs-builder documentation. Refer to the quick reference for a condensed syntax cheat sheet. docs-builder uses...
url: https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/3804/syntax
products:
  - Elastic Docs Builder
---

# Syntax guide
Learn about the Markdown syntax used in docs-builder documentation.

## Quick reference

Refer to the [quick reference](https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/3804/syntax/quick-ref) for a condensed syntax cheat sheet.

## How it works

docs-builder uses [CommonMark](https://commonmark.org)-compliant Markdown extended with [MyST](https://mystmd.org/)-inspired directives and roles. We are not using MyST directly — docs-builder has its own implementation of the directive and role extension points.
If you know [Markdown](https://commonmark.org), you already know most of what you need. If not, the CommonMark project offers a [10-minute tutorial](https://commonmark.org/help/).
When you need more than basic Markdown, you can use _directives_ to add features like callouts, tabs, diagrams, and more. To learn how directives work in general, including how to add options, arguments, and nest multiple directives, refer to [How directives work](https://docs-v3-preview.elastic.dev/elastic/docs-builder/pull/3804/syntax/directives). For a full list of available directives, refer to the sidebar.

## GitHub Flavored Markdown support

docs-builder supports some GitHub Flavored Markdown extensions:
**Supported:**
- Tables (basic pipe syntax)
- Strikethrough with `~~text~~` (renders as ~~text~~)

**Not supported:**
- Automatic URL linking: [https://www.elastic.co](https://www.elastic.co)
  - Links must use standard Markdown syntax: [Elastic](https://www.elastic.co)
- Using a subset of HTML