Syntax guide
Learn about the Markdown syntax used in docs-builder documentation.
Refer to the quick reference for a condensed syntax cheat sheet.
docs-builder uses CommonMark-compliant Markdown extended with MyST-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, you already know most of what you need. If not, the CommonMark project offers a 10-minute tutorial.
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. For a full list of available directives, refer to the sidebar.
docs-builder supports some GitHub Flavored Markdown extensions:
Supported:
- Tables (basic pipe syntax)
- Strikethrough with
~~text~~(renders astext)
Not supported:
- Automatic URL linking: https://www.elastic.co
- Links must use standard Markdown syntax: Elastic
- Using a subset of HTML