Callouts
1 Plugin · 7 Variants

Callouts / Admonition Plugin

Draw attention to important information with styled callout blocks. Seven built-in variants — tip, info, note, warning, caution, danger, and check.

Usage

setup.ts

import { createEditor } from '@synclineapi/mdx-editor';
import '@synclineapi/mdx-editor/style.css';

// All plugins included by default
const editor = createEditor({
  container: '#editor',
});

// Or import the admonition plugin individually
import { SynclineMDXEditor, admonitionPlugin } from '@synclineapi/mdx-editor';

const editor = new SynclineMDXEditor({
  container: '#editor',
  plugins: [admonitionPlugin()],
});

admonitionPlugin() — All Variants

Use the :::type fence syntax to create callouts. Each variant has a distinct colour and icon:

callouts.md

:::tip
This is a **tip** — use it for helpful suggestions and best practices.
:::

:::info
Informational callout for background context or explanations.
:::

:::note
A note for supplementary information that doesn't fit in body text.
:::

:::warning
Watch out — this edge case can cause unexpected behaviour.
:::

:::caution
Proceed carefully. This action may have side effects.
:::

:::danger
**Critical warning.** This will cause data loss if misused.
:::

:::check
All tests pass. You're good to deploy.
:::

Variant Reference

TypeIconColourBest Used For
tip💡
Green

Best practices, helpful suggestions

infoℹ️
Blue

Background context, explanations

note📝
Gray

Supplementary detail, side notes

warning⚠️
Yellow

Edge cases, potential issues

caution🔶
Orange

Actions with side effects

danger🔴
Red

Critical warnings, data loss risk

check
Green

Success confirmations, passed checks

Custom Titles

Override the default title by adding [Custom Title] after the type:

custom-titles.md

:::tip[Pro Tip]
You can override the default title text with a custom one.
:::

:::warning[Breaking Change in v2.0]
The API now returns paginated results by default.
:::

:::info[Did you know?]
SynclineMDX supports 35 built-in plugins out of the box.
:::

Nested Content

Callouts support full Markdown content inside, including lists, code blocks, blockquotes, and other formatting:

nested-callout.md

:::tip
You can nest **any Markdown** content inside callouts:

- Bullet lists
- **Bold** and *italic* text
- `inline code`

```typescript
const editor = createEditor({ container: '#editor' });
```

> Even blockquotes work inside callouts.
:::
SynclineMDX

© 2026 SynclineMDX Editor. All rights reserved.