Callouts
Inline asides — Note, Tip, Warning, Info, Check, Danger — plus the Update release block.
~ 2 min read
Seven block-level components for inline asides and changelog entries. All but <Update> share a single _Callout.astro shell — so to restyle every callout in one go, shadow theme/_Callout.astro.
| Component | Use for |
|---|---|
<Note> | Heads-up context the reader should notice but doesn’t need to act on |
<Tip> | Optional advice that improves their outcome |
<Warning> | ”Be careful — this can break things” |
<Info> | Neutral aside, slightly cooler than Note |
<Check> | Confirmation that a step worked |
<Danger> | Active danger — destructive ops, irreversible state |
<Update> | Dated release block for changelogs |
None of the callouts take props — they accept MDX children. <Update> is the exception.
Note
Most common callout. Caveats, environment requirements, references to related docs.
<Note>This page assumes Bun ≥ 1.1.</Note>If you’re writing “be careful — this can break things,” reach for <Warning>. If it’s actively dangerous, use <Danger>.
Tip
Optional advice that improves the reader’s outcome.
<Tip>Use `tangly dev --debug` to see the full Vite log when something looks off.</Tip>Warning
Reach for <Warning> when the reader could lose work, get stuck, or break something — but the action is still recoverable.
<Warning>
Running `tangly migrate` rewrites `mint.json` in place. Commit your changes first.
</Warning>Info
Neutral aside — slightly cooler in tone than <Note>. Use for “by the way” context that doesn’t fit the prose flow.
<Info>
Tangly's MDX pipeline disables Astro's image optimization. Mintlify projects use absolute URLs that bypass the asset pipeline anyway.
</Info>Check
Confirmation. Use after a step in a tutorial to mark “you should see X now.”
<Check>
Visit `http://localhost:4321` — you should see the default starter page.
</Check>Danger
Active, hard-to-recover danger. Destructive commands, schema migrations on prod, force-pushes.
<Danger>
`tangly eject --force` overwrites the runtime in place. There is no undo.
</Danger>Update
Dated release block for changelog entries. Heading on the left, date on the right, tag chips beside the heading, MDX body underneath.
| Prop | Type | Default | Description |
|---|---|---|---|
label | string | — | Version or release name. Renders as the heading. |
description | string | — | Subtitle, typically YYYY-MM-DD. |
tags | string[] | [] | Tag chips rendered to the right of the heading. |
<Update label="v0.2.0" description="2026-04-29" tags={["alpha"]}>
## Initial release
Renders Mintlify projects unmodified.
</Update>v0.2.0
2026-04-29Multi-tag
<Update label="v0.3.0" description="2026-06-15" tags={["minor", "ai-agents"]}>
- New `<PackageManager>` component
- `aiContext` frontmatter for agent hints
- Bun 1.3 minimum
</Update>v0.3.0
2026-06-15- New
<PackageManager>component aiContextfrontmatter for agent hints- Bun 1.3 minimum
Scaffolding
tangly add changelog 1.2.0Creates changelog/1.2.0.mdx with the <Update> block ready to fill in.
Source
Note.astro,Tip.astro,Warning.astro,Info.astro,Check.astro,Danger.astro- Shared shell:
_Callout.astro Update.astro