nuartz supports the same callout syntax as Obsidian. Use them to draw attention to important information in your notes.
Syntax
> [!type] Optional Title
> Callout content here. Supports **Markdown** and [[docs/features/wikilinks|wikilinks]].If you omit the title, the type name is used, capitalized, with hyphens shown as spaces. Any type name is accepted: types without their own style (below) use the default note colours and icon, and the type is exposed as data-callout="type" for your own CSS.
Foldable callouts
Add - after the type to start collapsed, or + to start expanded. Foldable callouts render as <details>/<summary>, so they toggle without JavaScript.
> [!faq]- Click to expand
> Hidden until opened.Click to expand
Hidden until opened.
Metadata
Text after a | inside the brackets is exposed as data-callout-metadata for custom styling, as in Obsidian:
> [!note|wide] TitleShowcase
Informational
Use note for general-purpose annotations.
Use info to provide additional context or background.
Use tip to share useful advice or shortcuts.
Use question for frequently asked questions or open-ended queries.
Status
Use success to indicate completed tasks or positive outcomes.
Use warning to flag potential issues or things to be careful about.
Use danger for critical alerts that require immediate attention.
Use bug to document known issues or unexpected behavior.
Content
Use example to show sample usage or demonstrations.
const garden = new Garden({ theme: "dark" })Imagination is more important than knowledge.
Use abstract (also: summary, tldr) for brief overviews.
- Implement callout parsing
- Add styling for all types
- Add collapsible callouts
Styled types and aliases: note; abstract, summary, tldr; info; todo; tip, hint; important; success, check, done; question, help, faq; warning, caution, attention; failure, fail, missing; danger, error; bug; example; quote, cite.
Nesting
Callouts can be nested inside each other:
You can nest callouts to create layered information structures.
Using Callouts Effectively
- Use callouts sparingly, since too many reduce their impact
- Pick the right type to match the intent of your message
- Keep callout content concise
- See Authoring Content for more writing tips