Guide

Callout

Use docspress/callout to separate an important note, tip, warning, danger, or success message from the surrounding lesson.

When to use it

Choose a callout for information a reader might otherwise miss. Do not place ordinary paragraphs in callouts for decoration. Use Result when the message is specifically the outcome of a procedure or check.

Edit the block

Edit the title and rich content in the canvas. Select the tone that matches the consequence. Enable Collapsible only for optional detail; open determines its initial state.

Attributes

Reference

Callout attributes

Message and disclosure behavior accepted by docspress/callout.
5 fields
tone enum

Semantic message severity.

title string

Formatted callout heading.

content string

Formatted HTML content.

collapsible boolean

Uses a native disclosure when enabled.

open boolean

Initial state of a collapsible callout.

Creative examples

Open preview tip

Preview first

Use a dry run before allowing Page writes.

Destructive-operation warning

Collapsed background detail

Why the cache refresh takes a minute

Edge nodes refresh independently. The published Page is already authoritative, but a reader in another region may briefly receive the previous copy.

Tone guide

ToneUse it for
noteContext or a neutral detail
tipA faster, safer, or more effective technique
warningA recoverable risk or prerequisite
dangerDestructive, security-sensitive, or difficult-to-reverse action
successConfirmation or a known-good state

Published behavior and accessibility

A standard callout renders as an aside. A collapsible callout uses native details and summary, so it remains operable without custom JavaScript. The tone is conveyed by text and structure as well as color.

Keep the title meaningful outside its surrounding paragraph. Do not hide required steps in a collapsed callout, and reserve danger for consequences that truly warrant interruption.

Was this helpful?