Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.

Directives

Directive

Description

Admonitions

Callout boxes (:::info, :::warning, :::note, :::tip, :::prompt) with optional custom titles.

Cloud directives

Conditionally render content for specific clouds (:::aws, :::azure, :::gcp, etc.).

Details

Collapsible sections with a clickable summary, often referred to as "expandos" (:::details).

Div

Wrap content in a <div> with a CSS class for custom styling (:::div).

Docs table of contents

Display a table of contents based on content structure (:::docs-toc).

Feed

Create RSS feed entries for release notes and other content (::::feed).

Include

Inline the contents of another Markdown file (::include).

List table

Render tables using a list-based syntax (:::list-table).

Literal include

Display the contents of a file in a code block (::literal-include).

Notebook

Embed a Databricks notebook (::notebook).

Replace

Define and use inline text replacements (::replace, :re).

Section table of contents

Display an inline TOC derived from the current page's headings (::section-toc).

Tabs

Render tabbed content with synced selection across tab groups (:::tabs, :::tab-item).

YouTube

Embed a playable YouTube video (::youtube).

Directive

Description

Admonitions

Callout boxes (:::info, :::warning, :::note, :::tip, :::prompt) with optional custom titles.

Cloud directives

Conditionally render content for specific clouds (:::aws, :::azure, :::gcp, etc.).

Details

Collapsible sections with a clickable summary, often referred to as "expandos" (:::details).

Div

Wrap content in a <div> with a CSS class for custom styling (:::div).

Docs table of contents

Display a table of contents based on content structure (:::docs-toc).

Feed

Create RSS feed entries for release notes and other content (::::feed).

Include

Inline the contents of another Markdown file (::include).

List table

Render tables using a list-based syntax (:::list-table).

Literal include

Display the contents of a file in a code block (::literal-include).

Notebook

Embed a Databricks notebook (::notebook).

Replace

Define and use inline text replacements (::replace, :re).

Section table of contents

Display an inline TOC derived from the current page's headings (::section-toc).

Tabs

Render tabbed content with synced selection across tab groups (:::tabs, :::tab-item).

YouTube

Embed a playable YouTube video (::youtube).

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 :::note inside ::::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.

On this page