Skip to content

Callout Types

Callout types are specific keywords used to generate styled, distinct content blocks within notes, primarily to highlight important information or organize content structure^[200-學習OB__plugin__admonition.md].

Supported Types

The system supports a variety of keywords that correspond to different visual styles and semantic meanings^[200-學習OB__plugin__admonition.md]. These keywords function as aliases, meaning different terms may produce the same visual result^[200-學習OB__plugin__admonition.md].

General & Informational * note: The standard callout type^[200-學習OB__plugin__admonition.md]. * abstract, summary, tldr: Used for summaries or condensed conclusions^[200-學習OB__plugin__admonition.md]. * info, todo: Used for general information or task lists^[200-學習OB__plugin__admonition.md].

Positive & Helpful * tip, hint, important: Used to highlight helpful advice or key takeaways^[200-學習OB__plugin__admonition.md]. * success, check, done: Used to indicate successful completion or verified items^[200-學習OB__plugin__admonition.md].

Interrogative & Assistance * question, help, faq: Used for posing questions or linking to help documentation^[200-學習OB__plugin__admonition.md].

Warning & Error * warning, caution, attention: Used to alert the reader to potential issues or risks^[200-學習OB__plugin__admonition.md]. * failure, fail, missing: Used to indicate failures or missing data^[200-學習OB__plugin__admonition.md]. * danger, error: Used for critical errors or dangerous situations^[200-學習OB__plugin__admonition.md]. * bug: Specifically used for reporting or tracking software bugs^[200-學習OB__plugin__admonition.md].

Content & Attribution * example: Used to provide examples^[200-學習OB__plugin__admonition.md]. * quote, cite: Used for citations or blockquotes^[200-學習OB__plugin__admonition.md].

Sources

  • 200-學習OB__plugin__admonition.md