Syntax guide
Learn about the custom Markdown syntax used in Elastic documentation.
Refer to the quick reference for a condensed syntax cheat sheet.
Elastic Docs V3 uses a custom implementation of MyST (Markedly Structured Text), which extends standard Markdown with directive syntax.
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, and diagrams. To learn how directives work in general, including how to add options and arguments and nest multiple directives, refer to How directives work. For a full list of available directives, refer to the sidebar.
V3 supports some GitHub Flavored Markdown extensions:
Supported:
- Tables (basic pipe syntax)
- Strikethrough with
~~text~~(renders astext)
Not supported:
- Task lists
- Automatic URL linking: https://www.elastic.co
- Links must use standard Markdown syntax: Elastic
- Using a subset of HTML