Clayo

Docs/Writing Docs

Using Markdown Directives

Clayo articles support standard markdown plus a set of directives — special blocks that render as richer components on your docs site.

Syntax

Directives use a fenced syntax with triple colons:

:::callout{type="info"}
This is an informational callout.
:::

Each directive has a name (like callout or video) and optional attributes in curly braces.

Available directives

Callout

Highlight important information with a styled box.

:::callout{type="warning"}
Be careful when deleting a project — this action cannot be undone.
:::

Types: info, warning, success, error

Video

Embed a video from YouTube, Loom, or Vimeo.

:::video{url="https://www.youtube.com/watch?v=dQw4w9WgXcQ"}
:::

Tabs

Group related content into switchable tabs using a nested container:

::::tabs
:::tab{title="macOS"}
Install with Homebrew: `brew install clayo`
:::
:::tab{title="Linux"}
Install with apt: `sudo apt install clayo`
:::
::::

Note the four colons on the outer tabs container and three on each inner tab.

Discovering directives

Your agent can call the directives endpoint to see all supported directives and their attributes. Ask it: "What directives does Clayo support?"