Callouts

Callouts (also known as admonitions) draw attention to important information. Use them for tips, warnings, notes, and more.

Basic Usage

Callouts are MDX components. Use them in your notes like this:

<Callout type="note">
  Your content here.
</Callout>

For general information and side notes.

ℹ️

Wiki-links are resolved case-insensitively, so the same note can be referenced regardless of capitalization.

For helpful suggestions and best practices.

💡

Best Practice

Use descriptive note titles. They make wiki-links more readable and help with search.

For important caveats or things to watch out for.

⚠️

Private notes (with private: true in frontmatter) are completely excluded from the build output.

For critical warnings that could cause problems.

🚨

Data Loss Risk

Never edit files directly in the src/generated/ directory. They are overwritten on each build.

For additional context or background information.

📖

Callouts support an optional title prop. Without it, only the icon is shown.

Add a title prop to customize the callout header:

<Callout type="tip" title="Pro Tip">
  Custom titles make callouts more specific.
</Callout>

Callouts can contain any Markdown content:

ℹ️

Rich Content

Callouts support:

Even blockquotes work inside callouts.