Callouts
Highlight important information with styled callout blocks. Unmarkdown supports 13 distinct callout types.
Syntax
Callouts use the GitHub-style blockquote syntax with a type identifier in square brackets. Place the type on the first line of the blockquote, then add your content below.
> [!NOTE]
> This is a note callout with helpful context.GitHub Standard Types
These five types follow the GitHub Markdown alert specification:
NOTE
General information and context. Rendered in blue.
> [!NOTE]
> API keys are scoped to your account, not individual documents.TIP
Best practices and helpful suggestions. Rendered in green.
> [!TIP]
> Use template_id "swiss" for a clean, modern default style.IMPORTANT
Critical information the reader must know. Rendered in purple.
> [!IMPORTANT]
> Single newlines render as line breaks due to remarkBreaks.
> Keep this in mind when pasting content from other editors.WARNING
Potential issues or things to watch out for. Rendered in amber.
> [!WARNING]
> Deleting a document also removes its published page.
> This action cannot be undone.CAUTION
Actions that could cause problems or data loss. Rendered in red.
> [!CAUTION]
> Regenerating your API key immediately invalidates the old key.
> All existing integrations will stop working.Extended Custom Types
Unmarkdown adds 8 custom callout types beyond the GitHub standard:
SUCCESS
Success states and completed actions. Rendered in emerald.
> [!SUCCESS]
> Your document has been published successfully.BUG
Known bugs and issues. Rendered in red.
> [!BUG]
> Tables inside nested blockquotes may not render alignment correctly.EXAMPLE
Example use cases and demonstrations. Rendered in indigo.
> [!EXAMPLE]
> To publish a document, call POST /v1/documents/:id/publish
> with your API key in the Authorization header.QUESTION
Common questions or things to consider. Rendered in blue.
> [!QUESTION]
> Which template should I use? Start with "swiss" for a clean look,
> or browse the template catalog for specialized designs.TODO
Action items and planned work. Rendered in yellow.
> [!TODO]
> Add error handling for 429 rate limit responses.QUOTE
Attributed quotes and citations. Rendered in gray.
> [!QUOTE]
> The best documentation is the kind you actually read.ABSTRACT
Summary or overview content. Rendered in cyan.
> [!ABSTRACT]
> This guide covers the complete publishing workflow:
> creating a document, choosing a template, and going live.FAILURE
Failed operations or error states. Rendered in red.
> [!FAILURE]
> The request was rejected because the API key has been revoked.Custom Titles
Override the default callout title by adding your custom title after the type identifier.
> [!TIP] Pro Tip
> You can combine callouts with other Markdown elements
> like **bold text**, `inline code`, and [links](https://unmarkdown.com).
> [!WARNING] Breaking Change in v2
> The `markdown` parameter has been renamed to `content`.Content Inside Callouts
Callouts can contain any Markdown content, including paragraphs, lists, code blocks, links, bold/italic text, and images.
> [!EXAMPLE] Publishing Workflow
> 1. Create a document with POST /v1/documents
> 2. Update the content with PATCH /v1/documents/:id
> 3. Publish with POST /v1/documents/:id/publish
>
> ```bash
> curl -X POST https://api.unmarkdown.com/v1/documents \
> -H "Authorization: Bearer um_your_api_key"
> ```Rendering Across Destinations
When you export a document, callouts are adapted to the destination format. Google Docs and Word render callouts as styled boxes with background colors. Email and Slack use bordered blockquotes. Plain text exports preserve the blockquote structure with a type label. Callouts render identically across all destinations that support rich formatting.