Using GitHub Callout Styles in Fanzine-CMS

📅 Sat, 16 aug 2025 👤 Daniel Dias Rodrigues

Editors working on Fanzine-CMS can improve readability by using GitHub’s callout styles. These blocks highlight important information directly in Markdown files. The three most useful types are:

Note – to provide extra context or clarification.
Tip – to share best practices or helpful shortcuts.
Warning – to emphasize risks, limitations, or potential errors.

Syntax examples

> [!note]
> This is a note.

📝 Note: This is a note.

> [!tip]
> This is a tip.

💡 Tip: This is a tip.

> [!warning]
> This is a warning.

⚠️ Warning: This is a warning.

Callout styles ensure that critical details stand out, making Fanzine-CMS documentation clearer and more user-friendly.

⚠️ Warning: Remember, callout styles are not case-sensitive: [!Warning], [!WARNING], and [!wArNiNg] are all correct.

The words Note, Tip and Warning are translatable in config.php, but you will always use [!note], [!tip] and [!warning] as markup.

Extra Tip for Editors

Not related to GitHub callouts, but editors can also use the <kbd> tag to show keyboard input in a clean way, for example:

<kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd>

Ctrl+Alt+Del

This adds visual clarity to shortcut instructions.

🔝