Includes

Import content from other Markdown files to avoid repetition.

Basic Usage

Include content from another file:

<!-- @include: ./shared/disclaimer.md -->

The included file’s content replaces the include directive.

Use Cases

Shared Warnings

Create a file with common warnings:

:::warning Beta Feature
This feature is in beta and may change in future releases.
:::

Include it in multiple pages:

<!-- @include: ./shared/beta-warning.md -->

## Feature Documentation

Your content here...

Reusable Snippets

Share installation instructions:

```bash
gem install docyard

```markdown
## Installation

<!-- @include: ./shared/install.md -->

Common Sections

Share footer content across pages:

---

## Need Help?

- Check the [FAQ](/faq)
- Join our [Discord](https://discord.gg/example)
- Open an [issue](https://github.com/example/repo/issues)

Path Resolution

Relative Paths

Paths starting with ./ or ../ are relative to the current file:

<!-- @include: ./sibling.md -->
<!-- @include: ../parent/file.md -->
<!-- @include: ./subfolder/file.md -->

Docs Root Paths

Paths without ./ resolve from your docs directory:

<!-- @include: shared/common.md -->

This includes docs/shared/common.md.

Nested Includes

Included files can include other files:

<!-- @include: ./branding.md -->

# Documentation

Docyard prevents circular includes and will show a warning if detected.

Syntax

<!-- @include: ./relative/path.md -->

<!-- @include: path/from/docs/root.md -->

Reference