Docs/Getting Started
Element Showcase — Every Supported Type
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Paragraphs and Inline Formatting
This is a regular paragraph with bold text, italic text, and bold italic text combined. You can also use inline code for short snippets. Here's some strikethrough text for good measure.
This second paragraph demonstrates a hard line break — the line below is separated by two trailing spaces.
This line follows a hard line break.
Links and Images
Here's a link to Clayo and a link with a title.
Blockquotes
This is a blockquote. It can contain bold, italic, and
code.It can also span multiple paragraphs within the quote block.
Unordered Lists
- First item
- Second item with bold
- Third item with nested children
- Nested item one
- Nested item two
- Deeply nested item
- Fourth item
Ordered Lists
- Step one — install the package
- Step two — configure your environment
- Step three — with nested unordered list
- Sub-point A
- Sub-point B
- Step four — ship it
Tables
| Feature | Free Plan | Pro Plan | Enterprise |
|---|---|---|---|
| Articles | 50 | Unlimited | Unlimited |
| Custom domain | No | Yes | Yes |
| AI answers | Basic | Advanced | Advanced |
| Support | Community | Dedicated |
Code Blocks
Inline code was shown above. Here's a fenced code block with syntax highlighting:
def greet(name: str) -> str:
"""Return a greeting."""
return f"Hello, {name}! Welcome to Clayo."
if __name__ == "__main__":
print(greet("World"))
const fetchDocs = async (subdomain) => {
const res = await fetch(`/public/${subdomain}/articles`);
return res.json();
};
npm install @clayo/widget
Horizontal Rules
The line below is a horizontal rule:
The line above is a horizontal rule.
Callouts
This is an info callout. Use it to surface helpful context or background information for the reader.
This is a tip callout. Use it to share best practices or shortcuts that save time.
This is a warning callout. Use it when the reader should proceed with caution or be aware of a potential pitfall.
This is a danger callout. Use it for destructive actions, breaking changes, or anything that could cause data loss.
Video Embeds
Align
This text is left-aligned (the default).
This text is center-aligned.
This text is right-aligned.
Tabs
import { ClayoWidget } from "@clayo/widget";
ClayoWidget.init({ projectId: "abc123" });
from clayo import Client
client = Client(project_id="abc123")
client.search("how do I reset my password?")
curl -X GET "https://api.clayo.com/public/my-docs/search?q=reset+password"
Accordion
Clayo is an agent-native help docs platform for teams shipping with AI coding tools. You author docs through your AI coding assistant — no web editor needed.
Clayo is free to use with a BYOK (bring your own key) model. You provide your own OpenAI API key for AI-powered features like search answers.
Yes! You can point your own subdomain (e.g. docs.yourapp.com) to your Clayo docs site. Configuration is available in project settings.
Combining Elements
You can nest any standard markdown inside directives — bold, italic, code, links, and lists:
- First nested ordered item
- Second nested ordered item
- Unordered inside a callout too
This callout lives inside a tab.
{
"nested": true,
"inside": "tabs"
}
That covers every supported element type: headings (h1–h6), paragraphs, bold, italic, bold-italic, strikethrough, inline code, hard line breaks, links, images, blockquotes, unordered lists, ordered lists, nested lists, tables, fenced code blocks (with language highlighting), horizontal rules, callouts (info/tip/warning/danger), video embeds (YouTube/Vimeo/Loom), align (left/center/right), tabs, and accordions.
