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.

Content atoms

↑ Docs content model

Content atoms are the lowest-level building blocks of a page: the Markdown and Docusaurus directives that everything else is composed from. A page section is assembled from atoms, a page type from sections, and a doc set from pages.

The directive atoms below are migrated from the legacy internal/directives/ reference, which remains in place until this model supersedes it.

Atom

Description

Admonitions

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

Cloud directives

Conditionally render content for specific clouds (:::aws, :::azure, :::gcp, :::sap, and combinations).

Code blocks

Fenced code blocks with language highlighting.

Details

Collapsible sections with a clickable summary, often called "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 the docs content structure (:::docs-toc).

Feed

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

Frontmatter

The YAML metadata block at the top of every page.

Headings

Heading levels and page heading structure.

Images

Embed images with alt text.

Include

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

Links

Inline links and cross-references between pages.

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).

Atom

Description

Admonitions

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

Cloud directives

Conditionally render content for specific clouds (:::aws, :::azure, :::gcp, :::sap, and combinations).

Code blocks

Fenced code blocks with language highlighting.

Details

Collapsible sections with a clickable summary, often called "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 the docs content structure (:::docs-toc).

Feed

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

Frontmatter

The YAML metadata block at the top of every page.

Headings

Heading levels and page heading structure.

Images

Embed images with alt text.

Include

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

Links

Inline links and cross-references between pages.

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).