Directives
Directive | Description |
|---|---|
Callout boxes ( | |
Conditionally render content for specific clouds ( | |
Collapsible sections with a clickable summary, often referred to as "expandos" ( | |
Wrap content in a | |
Display a table of contents based on content structure ( | |
Create RSS feed entries for release notes and other content ( | |
Inline the contents of another Markdown file ( | |
Render tables using a list-based syntax ( | |
Display the contents of a file in a code block ( | |
Embed a Databricks notebook ( | |
Define and use inline text replacements ( | |
Display an inline TOC derived from the current page's headings ( | |
Render tabbed content with synced selection across tab groups ( | |
Embed a playable YouTube video ( |
Fence rules
Container directives open with three or more colons and a name (:::note) and close with a fence of colons alone (:::). The build warns on any fence that breaks these rules, and warnings fail production builds:
- A directive nested inside another must use fewer colons than its parent. For example, put
:::noteinside::::aws, not inside:::aws. - A closing fence must use the same number of colons as its opening fence.
- Every directive needs its own closing fence, indented the same as its opening fence. A fence indented into the list item above ends with that item and leaves the closing fence behind as literal text.
- Every closing fence must close a directive.
- A cloud directive must not be empty.
The parser doesn't reject a miscounted fence. It re-nests the content instead, which can show cloud-specific content on every cloud, hide the rest of a page, or render ::: as text.