Use MDX Components
Build richer documentation with CamelMind's built-in MDX components. No imports required.
CamelMind includes built-in MDX components to make your documentation easier to read and navigate. Every component is available in any .mdx file—no imports or setup required.
Add Callout components
Use the Callout component to highlight notes, tips, warnings, important information, critical warnings, or success messages.
CamelMind provides the following Callout types:
<Callout type="note">A general note.</Callout>
<Callout type="tip">A helpful tip.</Callout>
<Callout type="warning">
Something to watch out for.
</Callout>
<Callout type="important">
Pay close attention.
</Callout>
<Callout type="danger">
A critical warning.
</Callout>
<Callout type="success">
Configuration saved successfully.
</Callout>
Customize a Callout title
Use the title prop to set a custom title for a Callout instead of its default heading.
<Callout
type="warning"
title="Rate limits apply"
>
The API accepts up to 1,000 requests per minute.
</Callout>
The API accepts up to 1,000 requests per minute.
Customize a Callout icon
Use the icon prop to replace the default Callout icon with a Lucide icon.
<Callout type="tip" icon="rocket">
Ready to launch.
</Callout>
Ready to launch.
Add Steps components
Use the Steps component to present installation instructions, tutorials, and other sequential workflows as a series of ordered steps.
<Steps>
<Step n={1} title="Install">
Run the installer.
</Step>
<Step n={2} title="Start">
Launch the development server.
</Step>
</Steps>
rendered as:
Add tabs components
Use tabs to organize related content that readers can switch between, such as instructions for different operating systems, languages, or configuration options.
=== "Tab 1"
Camels have remarkable desert adaptations. A hump stores up to 80 pounds of fat for energy rather than water.
=== "Tab 2"
Camels are surprisingly fast, able to run up to 40 miles per hour. They can carry up to 900 pounds for 25 miles a day.
===
rendered as:
Camels have remarkable desert adaptations. A hump stores up to 80 pounds of fat for energy rather than water.
Camels are surprisingly fast, able to run up to 40 miles per hour. They can carry up to 900 pounds for 25 miles a day.
Add Details components
Use Details to hide optional or advanced information behind a collapsible section.
<Details summary="Advanced configuration">
These settings are only needed for enterprise deployments.
</Details>
rendered as:
Advanced configuration
These settings are only needed for enterprise deployments.
Anchor-linkable details
Give a Details component an id to create a shareable link.
<Details
id="rate-limits"
summary="Rate limits"
>
Content...
</Details>
rendered as:
Rate limits
Content...
Display code blocks
Use standard Markdown code fences to display syntax-highlighted code with built-in copy, line-wrapping, and dark-mode support.
function greet(name: string) {
return `Hello ${name}`;
}
Control AI-visible content with LLMOnly and LLMIgnore
Use LLMOnly and LLMIgnore to control whether specific documentation content is visible to AI systems through llms.txt.
Content inside LLMOnly is included in llms.txt but hidden from the rendered documentation.
<LLMIgnore>
Internal implementation details.
</LLMIgnore>
Content inside LLMIgnore is visible to readers but omitted from llms.txt.
<LLMIgnore>
Internal implementation details.
</LLMIgnore>
See llms.txt for more information.