Include (::include)

↑ Docs content model

The ::include directive inlines the contents of another Markdown file, or a folder of Markdown files, into the current page.

When to use

Use ::include to reuse a block of content that must stay identical across pages — a shared prerequisite, a reused note, or the product release notes assembled from a folder of monthly files. Editing the source updates every page that includes it.

Technical details

Including a file

Markdown

::include[<filepath>]

The filepath is relative to the docs/web/includes/ directory, and the included file must exist within that directory. Any included files defined inside the included file are also included (nested includes).

Including a folder

A path ending in / includes every Markdown (.md) file directly in that folder, in filename order:

Markdown

::include[<folderpath>/]

The folderpath is relative to docs/web/includes/. Only .md files directly in the folder are included — non-.md files and subfolders are ignored, so folder includes are not recursive. Use the optional order attribute to control the order:

• order=asc (default): filename ascending.
• order=desc: filename descending.

Markdown

::include[<folderpath>/]{order=desc}

For example, ::include[product-release-notes/2026/07/]{order=desc} inlines every .md file in docs/web/includes/product-release-notes/2026/07/, newest first by filename. See docs/web/includes/product-release-notes/README.md for how the product release notes use this. Each file in the folder is included the same way as a single ::include, so nested includes and the circular-dependency rule apply to folder members too.

Rules

• The filepath (or folderpath) is relative to docs/web/includes/, and the target must exist there.
• No circular dependencies: a file must not (directly or indirectly) include itself. Circular includes cause build errors.
• Folder includes are not recursive — only .md files directly in the folder are included.

Style

• Keep included files self-contained so they read correctly on every page that inlines them.

Template

Markdown

::include[filepath.md]

Examples

File example

Assuming docs/web/includes/preview.md has content:

Markdown

:::info[Preview]

This feature is in Public Preview.

:::

Then:

Markdown

::include[preview.md]

Output:

Preview

This feature is in Public Preview.

Folder example

Assuming a folder docs/web/includes/an-include-folder/ has two .md files — file1.md (Some text in file1.md) and file2.md (Some text in file2.md):

Markdown

::include[an-include-folder/]{order=desc}

Output:

Markdown

Some text in file2.md

Some text in file1.md

Used in

Content atoms appear in any page section. Includes are common wherever shared content is reused, such as Requirements, and in the Release note page type.