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.
Last updated on

Include (::include)

We support the following syntax for including the contents of another Markdown 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 file will also be included.

warning

It is critical that there are no circular dependencies of included files.

For example, in include-1.md:

Markdown
::include[include-2.md]

If in include-2.md, you were to include include-1.md:

Markdown
::include[include-1.md]

This would yield a circular dependency, resulting in build errors.

Example:

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

:::info[Preview]

This feature is in Public Preview.

:::
Markdown
::include[preview.md]

Output:

Preview

This feature is in Public Preview.