Callouts
Highlight a note, a warning, or a tip with a coloured callout block. Four types, an optional title, and a custom icon.
Aktualisiert am 19. Nov. 20262 Min. Lesezeit
Callouts pull one piece of information out of the flow of the page so readers don't miss it. Each type has its own colour and icon.
<Callout type="info">
Typemark generates a sitemap for your published site. There's nothing to configure.
</Callout>
Types
Set type to info, warning, danger, or tip. Leave it out and you get info.
<Callout type="warning">
Rotating an API key signs out every client still using the old one.
</Callout>
<Callout type="danger">
Deleting a workspace removes all of its data. You can't undo it.
</Callout>
<Callout type="tip">
Type `/` in the visual editor and pick **Callout** to insert one without writing MDX.
</Callout>
| Type | Use it for |
|---|---|
info | Background, context, and side notes |
warning | Things that can go wrong if the reader isn't careful |
danger | Destructive or irreversible actions |
tip | Shortcuts and best practices |
Titles
Add title to give the callout a bold heading line.
<Callout type="info" title="Rate limits">
The API allows 100 requests per minute per key. Requests over the limit get a `429` response.
</Callout>
Custom icons
Each type has a default icon. Set icon to any Heroicons outline name to swap it.
<Callout type="tip" icon="rocket-launch">
Your site is live as soon as you create the project.
</Callout>
Props
| Prop | Type | Default | Description |
|---|---|---|---|
type | "info" | "warning" | "danger" | "tip" | "info" | Sets the colour and default icon. |
title | string | none | Bold heading shown above the content. |
icon | string | the type's icon | A Heroicons name, such as bolt or rocket-launch. |
Also accepted
These tag names render as callouts too, so pages written with them work without changes. They take title and icon as well.
| Tag | Renders as |
|---|---|
<Note> | info |
<Info> | info |
<Tip> | tip |
<Check> | tip, with a check-circle icon |
<Warning> | warning |
<Danger> | danger |
<Check>
Saved from the visual editor, a `<Note>` stays a `<Note>`. Typemark keeps the tag name you wrote.
</Check>
In the visual editor
Callouts render as coloured blocks you type straight into. Use the dropdown in the block to change the type, and the title field above the content to add a heading.