Callouts

A callout is a blockquote whose first line names its type. Use one to set a note, tip, or warning apart from the flow.

> [!tip] Keep it short
> One or two sentences, with **normal Markdown** inside.

Fold and nest supporting detail

Create paths/hint.page.md in an initialized project:

# Try before opening the hint

> [!question]- Need a hint?
> Compare the lightest and darkest parts first.
>
> > [!tip] Check your result
> > Read the heading from across the room.
Need a hint?

Compare the lightest and darkest parts first.

Run bun run dev and open /hint.page. The hint starts closed; activate its summary with Enter, Space, or a tap to reveal both the explanation and nested tip. Change - to + to start it open. Both work in reading and Play; the disclosure retains its native control behavior.

Contract

SyntaxMeaning
> [!type]Callout with the type name as its title
> [!type] TitleCallout with an authored title
> [!type]+ TitleFoldable, open by default
> [!type]- TitleFoldable, closed by default
> > [!type]Nested callout inside another callout's body

Built-in types and their aliases:

TypeAliases
note
abstractsummary, tldr
info
todo
tiphint, important
successcheck, done
questionhelp, faq
warningcaution, attention
failurefail, missing
dangererror
bug
example
quotecite

Notes

  • Unknown types render with the note appearance and keep their own data-callout attribute for CSS.
  • Foldable callouts render as native <details>, so they work without JavaScript.
  • Lists, tasks, code fences, and links work inside a callout body.